Reformat docs (#737)

* chore: reformat markdown files

* chore: ignore vim helptags

Help tags get auto-generated bei Neovim.

* docs: replace md2vim with panvimdoc in ci pipeline

* fixup! docs: replace md2vim with panvimdoc in ci pipeline

---------

Co-authored-by: Sebastian Flügge <[email protected]>

Author: seflue

.github/workflows/docgen.yml

@@ -12,11 +12,6 @@ jobs:
       - uses: actions/checkout@v4
         with:
           token: ${{ secrets.GH_TOKEN }}
-      - uses: actions/setup-go@v5
-        with:
-          go-version: '^1.17.1'
-      - name: Install md2vim
-        run: go install git.foosoft.net/alex/md2vim@latest
       - name: Install Neovim
         uses: rhysd/action-setup-vim@v1
         id: neovim
@@ -30,7 +25,10 @@ jobs:
       - name: Generate api docs
         run: make api_docs
       - name: Generate vim docs
-        run: make docs
+        uses: kdheepak/panvimdoc@main
+        with:
+          vimdoc: orgmode
+          pandoc: 'DOCS.md'
       - name: Commit changes
         env:
           GH_TOKEN: ${{ secrets.GH_TOKEN }}

.gitignore

@@ -39,3 +39,6 @@ luac.out
 
 # Directory containing testing dependencies downloaded during test run
 .deps/
+
+# Auto-generated vim helptags
+doc/tags

CONTRIBUTING.md

@@ -18,6 +18,7 @@ If you spot something missing in our [docs](DOCS.md), don't hesitate making a PR
 ## Local dev
 
 Requirements:
+
 - [StyLua](https://github.com/JohnnyMorganz/StyLua) - For formatting
 
 To set up local development, run `make setup_dev`. This will add a pre-commit hook that will auto format all files before committing them.
@@ -33,13 +34,15 @@ Please document any new code you add with [emmylua annotations](https://emmylua.
 
 ### Tests
 
- To run tests run `make test` in the nvim-orgmode directory:
+To run tests run `make test` in the nvim-orgmode directory:
+
 ```
 make test
 ```
 
 To run a specific test you can set a `FILE` environment variable to a specific
 spec you want to test. Example:
+
 ```
 make test FILE=./tests/plenary/api/api_spec.lua
 ```