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

Conversation

champignoom
Copy link
Contributor

@champignoom champignoom commented Jan 11, 2025

  • Add :help neorg-wiki, generated from wiki with https://github.com/pysan3/minorg and several pandoc filters
  • Rename :help neorg into :help norg
  • Rename :help neorg-cheatsheet into :help norg-cheatsheet
  • Remove :help neorg-breaking-changes, which didn't exist anyway
  • Remove all other :help neorg-*, which are more noisy than helpful

One can now browse neorg help pages with neorg's own infrastructure, like hopping among pages, and gO for showing a table of content for the options.

TODOs

(for the wiki itself)

  • Add missing links to entries (like Default-Keybinds.norg) into Home page body

@champignoom champignoom marked this pull request as draft January 11, 2025 18:52
@champignoom champignoom marked this pull request as ready for review January 11, 2025 19:25
Copy link
Contributor

@benlubas benlubas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a fan of this PR. few questions below, and additionally: can you add a CI pipeline to generate these automatically on merge with main?

doc/wiki/Autocommands.norg Outdated Show resolved Hide resolved
doc/wiki/_Sidebar.norg Outdated Show resolved Hide resolved
doc/wiki/Setup-Guide.norg Show resolved Hide resolved
@champignoom
Copy link
Contributor Author

can you add a CI pipeline to generate these automatically on merge with main?

I don't really know how, but here's the generator https://github.com/champignoom/neorg-help-gen.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants