Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: generate vim help pages in norg from wiki markdown #1634

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 3 additions & 42 deletions doc/tags
Original file line number Diff line number Diff line change
@@ -1,42 +1,3 @@
neorg neorg.norg /* The `.norg` File Format
neorg-advanced-markup neorg.norg /** Advanced Markup
neorg-anchors neorg.norg /*** Anchors
neorg-basic-markup neorg.norg /** Basic Markup
neorg-breaking-changes breaking-changes.norg /*NOTE:
neorg-carryover-tags neorg.norg /*** Carryover
neorg-code-blocks neorg.norg /*** Code Blocks
neorg-data-tags neorg.norg /** Data Tags
neorg-definitions neorg.norg /** Definitions
neorg-footnotes neorg.norg /** Footnotes
neorg-headings neorg.norg /*** Headings
neorg-indentation-reversal neorg.norg /***** Indentation reversion
neorg-link-descriptions neorg.norg /*** Custom link text
neorg-link-examples neorg.norg /*** Examples
neorg-link-locations neorg.norg /*** Pure link location
neorg-link-modifier neorg.norg /*** The Link modifier
neorg-link-targets neorg.norg /*** Link Targets
neorg-links neorg.norg /** Links
neorg-math neorg.norg /*** Math
neorg-media neorg.norg /*** Media
neorg-name-tag neorg.norg /*** Name
neorg-nested-markup neorg.norg /*** Nested markup
neorg-ordered-lists neorg.norg /*** Ordered lists
neorg-quotes neorg.norg /*** Quotes
neorg-tasks neorg.norg /*** Tasks
neorg-unordered-lists neorg.norg /*** Unordered lists
neorg-variables neorg.norg /*** Variables

neorg-cheatsheet cheatsheet.norg /* Your Quick Neorg Guide
neorg-cheatsheet-headings cheatsheet.norg /** Headings
neorg-cheatsheet-reverse-headings cheatsheet.norg /** Reverse Headings
neorg-cheatsheet-lists cheatsheet.norg /** Lists
neorg-cheatsheet-code-blocks cheatsheet.norg /** Code Blocks
neorg-cheatsheet-styling cheatsheet.norg /** Styling
neorg-cheatsheet-links-urls cheatsheet.norg /*** Links to URLs
neorg-cheatsheet-links-objects cheatsheet.norg /*** Links to Objects
neorg-cheatsheet-links-non-norg cheatsheet.norg /*** Links to non-norg Files
neorg-cheatsheet-links-descriptions cheatsheet.norg /*** Links with Descriptions
neorg-cheatsheet-links-anything cheatsheet.norg /*** Links to Anything
neorg-cheatsheet-links-files cheatsheet.norg /*** Links across Files
neorg-cheatsheet-anchors cheatsheet.norg /** Anchors
neorg-cheatsheet-tasks cheatsheet.norg /* Tasks
neorg-wiki wiki/Home.norg 1
norg neorg.norg /* The `.norg` File Format
norg-cheatsheet cheatsheet.norg /* Your Quick Neorg Guide
56 changes: 56 additions & 0 deletions doc/wiki/Autocommands.norg
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@

* `core.autocommands`

***

Handles the creation and management of Neovim’s autocommands.

* Overview

This internal module exposes functionality for subscribing to autocommands and performing actions based on those autocommands.

****** NOTE: This module will be soon deprecated, and it’s favourable to use the `vim.api*` functions instead.

In your `module.setup()`, make sure to require `core.autocommands` (`requires = { "core.autocommands" }`)
Afterwards in a function of your choice that gets called /after/ core.autocommmands gets intialized (e.g. `load()`):

@code lua
module.load = function()
module.required["core.autocommands"].enable_autocommand("VimLeavePre") -- Substitute VimLeavePre for any valid neovim autocommand
end
@end

Afterwards, be sure to subscribe to the event:

@code lua
module.events.subscribed = {
["core.autocommands"] = {
vimleavepre = true
}
}
@end

Upon receiving an event, it will come in this format:

@code lua
{
type = "core.autocommands.events.<name of autocommand, e.g. vimleavepre>",
broadcast = true
}
@end

* Configuration

This module provides no configuration options!

* 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.
champignoom marked this conversation as resolved.
Show resolved Hide resolved

22 changes: 22 additions & 0 deletions doc/wiki/Calendar.norg
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@

* `core.ui.calendar`

*** Frictionless Dates

The calendar module provides a range of functionality for different date-related tasks.

* Overview

The calendar is most often invoked with the intent of selecting a date, but may
also be launched in standalone mode, select date range mode and others.

To view keybinds and help, press `?` in the calendar view.

* Configuration

This module provides no configuration options!

* 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.

20 changes: 20 additions & 0 deletions doc/wiki/Clipboard-Code-Blocks.norg
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@

* `core.clipboard.code-blocks`

*** Comfortable Code Copying in Neorg

* Overview

The `code-blocks` module removes leading whitespace when copying from an `@code` tag, allowing
for easy pasting into external applications.

To use it, simply highlight some code within an `@code` block and paste it elsewhere!
This functionality will *only* work if the selection is inside the `@code` section,
excluding the `@code` and `@end` portion itself.

If the conditions are not met, the content is copied normally, preserving all indentation.

* Configuration

This module provides no configuration options!

18 changes: 18 additions & 0 deletions doc/wiki/Clipboard.norg
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@

* `core.clipboard`

*** Quality of Life Features for the Clipboard

* Overview

The clipboard module is a minimal and generic module allowing to overwrite or add special behaviour to the
`y` (yank) keybind in Neovim.

* 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.

43 changes: 43 additions & 0 deletions doc/wiki/Completion.norg
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@

* `core.completion`

*** Get completions in Neorg files

* Overview

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.

Completions are provided in the following cases (examples in (), `|||` represents the cursor location):
- TODO items (`|- (||`)
- @ tags (`|@||`)
- # tags (`|#||`)
- file path links (`|{:||`) provides workspace relative paths (`:$/workspace/relative/path:`)
- header links (`|{*||`)
- fuzzy header links (`|{#||`)
- footnotes (`|{^||`)
- file path + header links (`|{:path:*||`)
- file path + fuzzy header links (`|{:path:#||`)
- file path + footnotes (`|{:path:^||`)
- anchor names (`|[||`)
- link names (`|{<somelink>}[||`)

Header completions will show only valid headers at the current level in the current or specified file. All
link completions are smart about closing `:` and `}`.

* Configuration

** name (string)

The identifier for the Neorg source.

default: `"[Neorg]"`

* 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.

Loading
Loading