docs: Add gh action to deploy docs

Author: kristijanhusak

.github/workflows/docs.yml

@@ -0,0 +1,26 @@
+name: docs
+
+on:
+  push:
+    branches:
+      - feat/web-docs
+    paths:
+      - docs/**
+
+jobs:
+  docgen:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GH_TOKEN }}
+      - name: Push docs to nvim-orgmode.github.io repo
+        uses: nkoppel/push-files-to-another-repository@v1.1.4
+        env:
+          API_TOKEN_GITHUB: ${{ secrets.GH_TOKEN }}
+        with:
+          source-files: 'docs/'
+          destination-username: 'nvim-orgmode'
+          destination-repository: 'nvim-orgmode.github.io'
+          destination-branch: 'feat/vitepress'
+          commit-email: 'github-actions@github.com'

docs/index.org

@@ -5,7 +5,6 @@ It aims to be a feature-complete implementation of Orgmode features in Neovim.
 
 💡 TIP: To view this documentation offline in Neovim, run =:Org help=. More info in [[#globals-and-commands][Globals and commands]] section.
 
-
 ** Quick start
 :PROPERTIES:
 :CUSTOM_ID: quick-start
@@ -46,7 +45,7 @@ that demonstrates how the similar Orgmode clone [[https://github.com/dhruvasagar
 :PROPERTIES:
 :CUSTOM_ID: api-docs
 :END:
-Nvim-orgmode exoses a Lua API that can be used to interact with the orgmode. To view it, check [[file:../docs/orgmode-api.txt][orgmode-api.txt]]
+Nvim-orgmode exposes a Lua API that can be used to interact with the orgmode. To view it, check [[file:../docs/orgmode-api.txt][orgmode-api.txt]]
 or do =:h OrgApi= in Neovim.
 
 ** Globals and commands