Skip to content

Commit

Permalink
docs: fix help pages
Browse files Browse the repository at this point in the history
  • Loading branch information
champignoom committed Jan 11, 2025
1 parent cbc2869 commit 975636e
Show file tree
Hide file tree
Showing 43 changed files with 122 additions and 174 deletions.
16 changes: 8 additions & 8 deletions doc/wiki/Autocommands.norg
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,12 @@

* Required By

- {https://github.com/nvim-neorg/neorg/wiki/Concealer}[`core.concealer`] - Enhances the basic Neorg experience by using icons instead of text.
- {https://github.com/nvim-neorg/neorg/wiki/Dirman}[`core.dirman`] - This module is be responsible for managing directories full of .norg files.
- {https://github.com/nvim-neorg/neorg/wiki/Indent}[`core.esupports.indent`] - A set of instructions for Neovim to indent Neorg documents.
- {https://github.com/nvim-neorg/neorg/wiki/Metagen}[`core.esupports.metagen`] - A Neorg module for generating document metadata automatically.
- {https://github.com/nvim-neorg/neorg/wiki/Core-Highlights}[`core.highlights`] - Manages your highlight groups with this module.
- {https://github.com/nvim-neorg/neorg/wiki/Core-Latex-Renderer}[`core.latex.renderer`] - An experimental module for rendering latex images inline.
- {https://github.com/nvim-neorg/neorg/wiki/Storage}[`core.storage`] - Deals with storing persistent data across Neorg sessions.
- {https://github.com/nvim-neorg/neorg/wiki/Syntax}[`core.syntax`] - Handles interaction for syntax files for code blocks.
- {:Concealer:}[`core.concealer`] - Enhances the basic Neorg experience by using icons instead of text.
- {:Dirman:}[`core.dirman`] - This module is be responsible for managing directories full of .norg files.
- {:Indent:}[`core.esupports.indent`] - A set of instructions for Neovim to indent Neorg documents.
- {:Metagen:}[`core.esupports.metagen`] - A Neorg module for generating document metadata automatically.
- {:Core-Highlights:}[`core.highlights`] - Manages your highlight groups with this module.
- {:Core-Latex-Renderer:}[`core.latex.renderer`] - An experimental module for rendering latex images inline.
- {:Storage:}[`core.storage`] - Deals with storing persistent data across Neorg sessions.
- {:Syntax:}[`core.syntax`] - Handles interaction for syntax files for code blocks.

2 changes: 1 addition & 1 deletion doc/wiki/Calendar.norg
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@

* Dependencies

- {https://github.com/nvim-neorg/neorg/wiki/Core-UI}[`core.ui`] - A set of public functions to help developers create and manage UI (selection popups, prompts…) in their modules.
- {:Core-UI:}[`core.ui`] - A set of public functions to help developers create and manage UI (selection popups, prompts…) in their modules.

2 changes: 1 addition & 1 deletion doc/wiki/Clipboard.norg
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@

* Dependencies

- {https://github.com/nvim-neorg/neorg/wiki/Treesitter-Integration}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.
- {:Treesitter-Integration:}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.

10 changes: 5 additions & 5 deletions doc/wiki/Completion.norg
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@

This module is an intermediary between Neorg and the completion engine of your choice. After setting up this
module (this usually just involves setting the `engine` field in the {# configuration} section),
please read the corresponding wiki page for the engine you selected ({https://github.com/nvim-neorg/neorg/wiki/Nvim-Cmp}[`nvim-cmp`]
{@core.integrations.coq_nvim}[`coq_nvim`] or {https://github.com/nvim-neorg/neorg/wiki/Nvim-Compe}[`nvim-compe`]) to complete setup.
please read the corresponding wiki page for the engine you selected ({:Nvim-Cmp:}[`nvim-cmp`]
{@core.integrations.coq_nvim}[`coq_nvim`] or {:Nvim-Compe:}[`nvim-compe`]) to complete setup.

Completions are provided in the following cases (examples in (), `|||` represents the cursor location):
- TODO items (`|- (||`)
Expand Down Expand Up @@ -37,7 +37,7 @@

* Dependencies

- {https://github.com/nvim-neorg/neorg/wiki/Dirman}[`core.dirman`] - This module is be responsible for managing directories full of .norg files.
- {https://github.com/nvim-neorg/neorg/wiki/Dirman-Utils}[`core.dirman.utils`] - A set of utilities for the `core.dirman` module.
- {https://github.com/nvim-neorg/neorg/wiki/Treesitter-Integration}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.
- {:Dirman:}[`core.dirman`] - This module is be responsible for managing directories full of .norg files.
- {:Dirman-Utils:}[`core.dirman.utils`] - A set of utilities for the `core.dirman` module.
- {:Treesitter-Integration:}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.

4 changes: 2 additions & 2 deletions doc/wiki/Concealer.norg
Original file line number Diff line number Diff line change
Expand Up @@ -563,6 +563,6 @@

* Dependencies

- {https://github.com/nvim-neorg/neorg/wiki/Autocommands}[`core.autocommands`] - Handles the creation and management of Neovim’s autocommands.
- {https://github.com/nvim-neorg/neorg/wiki/Treesitter-Integration}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.
- {:Autocommands:}[`core.autocommands`] - Handles the creation and management of Neovim’s autocommands.
- {:Treesitter-Integration:}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.

2 changes: 1 addition & 1 deletion doc/wiki/Cookbook.norg
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
for a just works experience.

> [!TIP]
If you’re looking for a quickstart setup to get you started with Neorg, check out the {https://github.com/nvim-neorg/neorg/wiki/Kickstart}[kickstart page] instead.
If you’re looking for a quickstart setup to get you started with Neorg, check out the {:Kickstart:}[kickstart page] instead.

** Completion with `nvim-cmp`

Expand Down
2 changes: 1 addition & 1 deletion doc/wiki/Coq_nvim.norg
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

* Overview

This module works with the {https://github.com/nvim-neorg/neorg/wiki/Completion}[`core.completion`] module to attempt to provide
This module works with the {:Completion:}[`core.completion`] module to attempt to provide
intelligent completions. Note that integrations like this are second-class citizens and may not work in 100%
of scenarios. If they don’t then please file a bug report!

Expand Down
6 changes: 3 additions & 3 deletions doc/wiki/Core-Highlights.norg
Original file line number Diff line number Diff line change
Expand Up @@ -707,10 +707,10 @@

* Dependencies

- {https://github.com/nvim-neorg/neorg/wiki/Autocommands}[`core.autocommands`] - Handles the creation and management of Neovim’s autocommands.
- {:Autocommands:}[`core.autocommands`] - Handles the creation and management of Neovim’s autocommands.

* Required By

- {https://github.com/nvim-neorg/neorg/wiki/Treesitter-Integration}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.
- {https://github.com/nvim-neorg/neorg/wiki/Core-Latex-Renderer}[`core.latex.renderer`] - An experimental module for rendering latex images inline.
- {:Treesitter-Integration:}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.
- {:Core-Latex-Renderer:}[`core.latex.renderer`] - An experimental module for rendering latex images inline.

8 changes: 4 additions & 4 deletions doc/wiki/Core-Latex-Renderer.norg
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@

* Dependencies

- {https://github.com/nvim-neorg/neorg/wiki/Autocommands}[`core.autocommands`] - Handles the creation and management of Neovim’s autocommands.
- {https://github.com/nvim-neorg/neorg/wiki/Core-Highlights}[`core.highlights`] - Manages your highlight groups with this module.
- {https://github.com/nvim-neorg/neorg/wiki/Treesitter-Integration}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.
- {https://github.com/nvim-neorg/neorg/wiki/Neorgcmd-Module}[`core.neorgcmd`] - This module deals with handling everything related to the `:Neorg` command.
- {:Autocommands:}[`core.autocommands`] - Handles the creation and management of Neovim’s autocommands.
- {:Core-Highlights:}[`core.highlights`] - Manages your highlight groups with this module.
- {:Treesitter-Integration:}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.
- {:Neorgcmd-Module:}[`core.neorgcmd`] - This module deals with handling everything related to the `:Neorg` command.

6 changes: 3 additions & 3 deletions doc/wiki/Core-Presenter.norg
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@

* Dependencies

- {https://github.com/nvim-neorg/neorg/wiki/Treesitter-Integration}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.
- {https://github.com/nvim-neorg/neorg/wiki/Queries-Module}[`core.queries.native`] - TS wrapper in order to fetch nodes using a custom table.
- {https://github.com/nvim-neorg/neorg/wiki/Core-UI}[`core.ui`] - A set of public functions to help developers create and manage UI (selection popups, prompts…) in their modules.
- {:Treesitter-Integration:}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.
- {:Queries-Module:}[`core.queries.native`] - TS wrapper in order to fetch nodes using a custom table.
- {:Core-UI:}[`core.ui`] - A set of public functions to help developers create and manage UI (selection popups, prompts…) in their modules.

12 changes: 6 additions & 6 deletions doc/wiki/Core-UI.norg
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@

* Required By

- {https://github.com/nvim-neorg/neorg/wiki/Dirman}[`core.dirman`] - This module is be responsible for managing directories full of .norg files.
- {https://github.com/nvim-neorg/neorg/wiki/Esupports-Hop}[`core.esupports.hop`] - "Hop" between Neorg links, following them with a single keypress.
- {https://github.com/nvim-neorg/neorg/wiki/Looking-Glass}[`core.looking-glass`] - Allows for editing of code blocks within a separate buffer.
- {https://github.com/nvim-neorg/neorg/wiki/Core-Presenter}[`core.presenter`] - Neorg module to create gorgeous presentation slides.
- {https://github.com/nvim-neorg/neorg/wiki/TOC}[`core.qol.toc`] - Generates a table of contents for a given Norg buffer.
- {https://github.com/nvim-neorg/neorg/wiki/Calendar}[`core.ui.calendar`] - Opens an interactive calendar for date-related tasks.
- {:Dirman:}[`core.dirman`] - This module is be responsible for managing directories full of .norg files.
- {:Esupports-Hop:}[`core.esupports.hop`] - "Hop" between Neorg links, following them with a single keypress.
- {:Looking-Glass:}[`core.looking-glass`] - Allows for editing of code blocks within a separate buffer.
- {:Core-Presenter:}[`core.presenter`] - Neorg module to create gorgeous presentation slides.
- {:TOC:}[`core.qol.toc`] - Generates a table of contents for a given Norg buffer.
- {:Calendar:}[`core.ui.calendar`] - Opens an interactive calendar for date-related tasks.

2 changes: 1 addition & 1 deletion doc/wiki/Default-Keybinds.norg
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

*** Further Reading

To find out how to rebind the available keys consult the {https://github.com/nvim-neorg/neorg/wiki/User-Keybinds}[`core.keybinds`] wiki entry.
To find out how to rebind the available keys consult the {:User-Keybinds:}[`core.keybinds`] wiki entry.

** Preset `neorg` // All Files

Expand Down
8 changes: 4 additions & 4 deletions doc/wiki/Dirman-Utils.norg
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

* Overview

This internal submodule implements some basic utility functions for {https://github.com/nvim-neorg/neorg/wiki/Dirman}[`core.dirman`].
This internal submodule implements some basic utility functions for {:Dirman:}[`core.dirman`].
Currently the only exposed API function is `expand_path`, which takes a path like `$name/my/location` and
converts `$name` into the full path of the workspace called `name`.

Expand All @@ -15,7 +15,7 @@

* Required By

- {https://github.com/nvim-neorg/neorg/wiki/Completion}[`core.completion`] - A wrapper to interface with several different completion engines.
- {https://github.com/nvim-neorg/neorg/wiki/Dirman}[`core.dirman`] - This module is be responsible for managing directories full of .norg files.
- {https://github.com/nvim-neorg/neorg/wiki/Esupports-Hop}[`core.esupports.hop`] - "Hop" between Neorg links, following them with a single keypress.
- {:Completion:}[`core.completion`] - A wrapper to interface with several different completion engines.
- {:Dirman:}[`core.dirman`] - This module is be responsible for managing directories full of .norg files.
- {:Esupports-Hop:}[`core.esupports.hop`] - "Hop" between Neorg links, following them with a single keypress.

12 changes: 6 additions & 6 deletions doc/wiki/Dirman.norg
Original file line number Diff line number Diff line change
Expand Up @@ -99,13 +99,13 @@

* Dependencies

- {https://github.com/nvim-neorg/neorg/wiki/Autocommands}[`core.autocommands`] - Handles the creation and management of Neovim’s autocommands.
- {https://github.com/nvim-neorg/neorg/wiki/Dirman-Utils}[`core.dirman.utils`] - A set of utilities for the `core.dirman` module.
- {https://github.com/nvim-neorg/neorg/wiki/Storage}[`core.storage`] - Deals with storing persistent data across Neorg sessions.
- {https://github.com/nvim-neorg/neorg/wiki/Core-UI}[`core.ui`] - A set of public functions to help developers create and manage UI (selection popups, prompts…) in their modules.
- {:Autocommands:}[`core.autocommands`] - Handles the creation and management of Neovim’s autocommands.
- {:Dirman-Utils:}[`core.dirman.utils`] - A set of utilities for the `core.dirman` module.
- {:Storage:}[`core.storage`] - Deals with storing persistent data across Neorg sessions.
- {:Core-UI:}[`core.ui`] - A set of public functions to help developers create and manage UI (selection popups, prompts…) in their modules.

* Required By

- {https://github.com/nvim-neorg/neorg/wiki/Completion}[`core.completion`] - A wrapper to interface with several different completion engines.
- {https://github.com/nvim-neorg/neorg/wiki/Journal}[`core.journal`] - Easily track a journal within Neorg.
- {:Completion:}[`core.completion`] - A wrapper to interface with several different completion engines.
- {:Journal:}[`core.journal`] - Easily track a journal within Neorg.

6 changes: 3 additions & 3 deletions doc/wiki/Esupports-Hop.norg
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@

* Dependencies

- {https://github.com/nvim-neorg/neorg/wiki/Dirman-Utils}[`core.dirman.utils`] - A set of utilities for the `core.dirman` module.
- {https://github.com/nvim-neorg/neorg/wiki/Treesitter-Integration}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.
- {https://github.com/nvim-neorg/neorg/wiki/Core-UI}[`core.ui`] - A set of public functions to help developers create and manage UI (selection popups, prompts…) in their modules.
- {:Dirman-Utils:}[`core.dirman.utils`] - A set of utilities for the `core.dirman` module.
- {:Treesitter-Integration:}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.
- {:Core-UI:}[`core.ui`] - A set of public functions to help developers create and manage UI (selection popups, prompts…) in their modules.

2 changes: 1 addition & 1 deletion doc/wiki/Exporting-Files.norg
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,5 @@

* Dependencies

- {https://github.com/nvim-neorg/neorg/wiki/Treesitter-Integration}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.
- {:Treesitter-Integration:}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.

8 changes: 4 additions & 4 deletions doc/wiki/Indent.norg
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
`core.esupports.indent` uses Norg’s format to unambiguously determine
the indentation level for the current line.

The indent calculation is aided by {https://github.com/nvim-neorg/neorg/wiki/Treesitter-Integration}[treesitter], which
The indent calculation is aided by {:Treesitter-Integration:}[treesitter], which
means that the quality of indents is "limited" by the quality of the produced syntax tree,
which will get better and better with time.

Expand Down Expand Up @@ -201,10 +201,10 @@

* Dependencies

- {https://github.com/nvim-neorg/neorg/wiki/Autocommands}[`core.autocommands`] - Handles the creation and management of Neovim’s autocommands.
- {https://github.com/nvim-neorg/neorg/wiki/Treesitter-Integration}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.
- {:Autocommands:}[`core.autocommands`] - Handles the creation and management of Neovim’s autocommands.
- {:Treesitter-Integration:}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.

* Required By

- {https://github.com/nvim-neorg/neorg/wiki/Promo}[`core.promo`] - Promotes or demotes nestable items within Neorg files.
- {:Promo:}[`core.promo`] - Promotes or demotes nestable items within Neorg files.

4 changes: 2 additions & 2 deletions doc/wiki/Itero.norg
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* |
@end

This functionality is commonly paired with the {https://github.com/nvim-neorg/neorg/wiki/Promo}[`core.promo`] module to then indent/dedent
This functionality is commonly paired with the {:Promo:}[`core.promo`] module to then indent/dedent
the item under the cursor with the `<C-t>` and `<C-d>` bindings.

* Configuration
Expand Down Expand Up @@ -66,5 +66,5 @@

* Dependencies

- {https://github.com/nvim-neorg/neorg/wiki/Treesitter-Integration}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.
- {:Treesitter-Integration:}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.

4 changes: 2 additions & 2 deletions doc/wiki/Journal.norg
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,6 @@

* Dependencies

- {https://github.com/nvim-neorg/neorg/wiki/Dirman}[`core.dirman`] - This module is be responsible for managing directories full of .norg files.
- {https://github.com/nvim-neorg/neorg/wiki/Treesitter-Integration}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.
- {:Dirman:}[`core.dirman`] - This module is be responsible for managing directories full of .norg files.
- {:Treesitter-Integration:}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.

2 changes: 1 addition & 1 deletion doc/wiki/Kickstart.norg
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
** Troubleshooting

If you have any issues like bold/italic not rendering or highlights being improperly applied
I encourage you to check out the {https://github.com/nvim-neorg/neorg/wiki/Dependencies}[dependencies document] which explains troubleshooting steps
I encourage you to check out the {:Dependencies:}[dependencies document] which explains troubleshooting steps
for different kinds of terminals.

With that, let’s begin!
Expand Down
6 changes: 3 additions & 3 deletions doc/wiki/Looking-Glass.norg
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@

The magnify command can be accessed by running `:Neorg keybind all core.looking-glass.magnify-code-block` with your cursor underneath the code
block you would like to magnify - it is not bound to any key as of currently,
but you may map it yourself via the {https://github.com/nvim-neorg/neorg/wiki/User-Keybinds}[`core.keybinds`] module.
but you may map it yourself via the {:User-Keybinds:}[`core.keybinds`] module.

* Configuration

This module provides no configuration options!

* Dependencies

- {https://github.com/nvim-neorg/neorg/wiki/Treesitter-Integration}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.
- {https://github.com/nvim-neorg/neorg/wiki/Core-UI}[`core.ui`] - A set of public functions to help developers create and manage UI (selection popups, prompts…) in their modules.
- {:Treesitter-Integration:}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.
- {:Core-UI:}[`core.ui`] - A set of public functions to help developers create and manage UI (selection popups, prompts…) in their modules.

2 changes: 1 addition & 1 deletion doc/wiki/Markdown-Export.norg
Original file line number Diff line number Diff line change
Expand Up @@ -80,5 +80,5 @@

* Dependencies

- {https://github.com/nvim-neorg/neorg/wiki/Treesitter-Integration}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.
- {:Treesitter-Integration:}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.

4 changes: 2 additions & 2 deletions doc/wiki/Metagen.norg
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,6 @@

* Dependencies

- {https://github.com/nvim-neorg/neorg/wiki/Autocommands}[`core.autocommands`] - Handles the creation and management of Neovim’s autocommands.
- {https://github.com/nvim-neorg/neorg/wiki/Treesitter-Integration}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.
- {:Autocommands:}[`core.autocommands`] - Handles the creation and management of Neovim’s autocommands.
- {:Treesitter-Integration:}[`core.integrations.treesitter`] - A module designed to integrate Treesitter into Neorg.

6 changes: 3 additions & 3 deletions doc/wiki/Neorgcmd-Module.norg
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@

* Required By

- {https://github.com/nvim-neorg/neorg/wiki/Core-Latex-Renderer}[`core.latex.renderer`] - An experimental module for rendering latex images inline.
- {https://github.com/nvim-neorg/neorg/wiki/Neorgcmd-return}[`core.neorgcmd.commands.return`] - Return to last location before entering Neorg.
- {https://github.com/nvim-neorg/neorg/wiki/Tangling}[`core.tangle`] - An Advanced Code Block Exporter.
- {:Core-Latex-Renderer:}[`core.latex.renderer`] - An experimental module for rendering latex images inline.
- {:Neorgcmd-return:}[`core.neorgcmd.commands.return`] - Return to last location before entering Neorg.
- {:Tangling:}[`core.tangle`] - An Advanced Code Block Exporter.

Loading

0 comments on commit 975636e

Please sign in to comment.