feat(docs): Add orgmode docs (#864)

feat(docs): Add orgmode docs
nvim-orgmode · Jan 19, 2025 · 9801148 · 9801148
1 parent 3ba6db7
commit 9801148
Show file tree

Hide file tree

Showing 15 changed files with 4,143 additions and 313 deletions.
diff --git a/.github/workflows/docgen.yml b/.github/workflows/docgen.yml
@@ -12,11 +12,10 @@ jobs:
       - uses: actions/checkout@v4
         with:
           token: ${{ secrets.GH_TOKEN }}
-      - uses: actions/setup-go@v5
+      - name: Install pandoc
+        uses: pandoc/actions/setup@v1
         with:
-          go-version: '^1.17.1'
-      - name: Install md2vim
-        run: go install git.foosoft.net/alex/md2vim@latest
+          version: 3.5
       - name: Install Neovim
         uses: rhysd/action-setup-vim@v1
         id: neovim
@@ -30,7 +29,7 @@ jobs:
       - name: Generate api docs
         run: make api_docs
       - name: Generate vim docs
-        run: make docs
+        run: make vim_docs
       - name: Commit changes
         env:
           GH_TOKEN: ${{ secrets.GH_TOKEN }}

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
diff --git a/CONTRIBUTING.org b/CONTRIBUTING.org
@@ -0,0 +1 @@
+* Check [[file:./docs/contributing.org][contributing]] for more information
diff --git a/Makefile b/Makefile
@@ -2,8 +2,8 @@ clean:
 	nvim --headless --clean -n -c "lua vim.fn.delete('./tests/.deps', 'rf')" +q
 test:
 	nvim --headless --clean -u tests/test.lua "$(FILE)"
-docs:
-	md2vim -desc "*orgmode* *orgmode.nvim*\n* NOTE: This file is autogenerated from DOCS.md file" DOCS.md doc/orgmode.txt
+vim_docs:
+	./scripts/build_docs.sh
 api_docs:
 	nvim --headless --clean -u ./scripts/gendoc.lua
 setup_dev:
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		* Check [[file:./docs/contributing.org][contributing]] for more information