Skip to content

Commit 0d723fd

Browse files
authored
chore(docs): fixup and add to some docs (#1299)
1 parent 1ab15f4 commit 0d723fd

File tree

4 files changed

+31
-3
lines changed

4 files changed

+31
-3
lines changed

lua/neorg/modules/core/completion/module.lua

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ or [`nvim-compe`](@core.integrations.nvim-compe)) to complete setup.
1212
Completions are provided in the following cases (examples in (), `|` represents the cursor location):
1313
- TODO items (`- (|`)
1414
- @ tags (`@|`)
15-
- # tags (`#|`)
15+
- \# tags (`#|`)
1616
- file path links (`{:|`) provides workspace relative paths (`:$/workspace/relative/path:`)
1717
- header links (`{*|`)
1818
- fuzzy header links (`{#|`)

lua/neorg/modules/core/concealer/module.lua

+3
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ masks, or sometimes completely hides many categories of markup.
1313
1414
The concealer depends on [Nerd Fonts >=v3.0.1](https://github.com/ryanoasis/nerd-fonts/releases/latest) to be
1515
installed on your system.
16+
17+
This module respects `:h conceallevel` and `:h concealcursor`. Setting the wrong values for these options can
18+
make it look like this module isn't working.
1619
--]]
1720

1821
-- utils to be refactored

lua/neorg/modules/core/integrations/image/module.lua

+4
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
title: Images Directly within Neovim.
44
description: The `image` module uses various terminal backends to display images within your Neovim instance.
55
summary: Module for interacting with and managing images in the terminal.
6+
internal: true
7+
---
8+
9+
`core.integrations.image` is an internal module that wraps image.nvim, exposing methods to display images in neovim.
610
--]]
711

812
local neorg = require("neorg.core")

lua/neorg/modules/core/latex/renderer/module.lua

+23-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,20 @@
1+
--[[
2+
file: Core-Latex-Renderer
3+
title: Rendering LaTeX with image.nvim
4+
summary: An experimental module for inline rendering latex images
5+
---
6+
7+
This is an experimental module that requires nvim 0.10+. It renders LaTeX snippets as images
8+
making use of the image.nvim plugin. By default, images are only rendered after running the
9+
command: `:Neorg render-latex`.
10+
11+
Requires [image.nvim](https://github.com/3rd/image.nvim).
12+
--]]
113
local neorg = require("neorg.core")
214
local module = neorg.modules.create("core.latex.renderer")
315
local modules = neorg.modules
416

5-
assert(vim.re ~= nil, "Neovim 0.10.0+ is required to run the `core.renderer.latex` module! ")
17+
assert(vim.re ~= nil, "Neovim 0.10.0+ is required to run the `core.renderer.latex` module!")
618

719
module.setup = function()
820
return {
@@ -163,11 +175,20 @@ module.public = {
163175
}
164176

165177
module.config.public = {
166-
-- TODO: Documentation
178+
-- When true, images of rendered LaTeX will cover the source LaTeX they were produced from
167179
conceal = true,
180+
181+
-- "Dots Per Inch" increasing this value will result in crisper images at the expense of
182+
-- performance
168183
dpi = 350,
184+
185+
-- When true, images will render when a `.norg` buffer is entered
169186
render_on_enter = false,
187+
188+
-- Module that renders the images. This is currently the only option
170189
renderer = "core.integrations.image",
190+
191+
-- make the images larger or smaller by adjusting the scale
171192
scale = 1,
172193
}
173194

0 commit comments

Comments
 (0)