Add documentation generation and gif examples of plugin

.github/workflows/docs.yml

@@ -0,0 +1,29 @@
+name: docs
+on:
+  push:
+    branches:
+      - "main"
+    paths:
+      - "README.org"
+      - ".github/workflows/docs.yml"
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+    name: pandoc to vimdoc
+    permissions:
+      # Give the default GITHUB_TOKEN write permission to commit and push the
+      # added or changed files to the repository.
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: panvimdoc
+        uses: kdheepak/[email protected]
+        with:
+          vimdoc: org-mouse
+          pandoc: README.org
+          toc: true
+          treesitter: true
+          version: "NVIM v0.9.2"
+      - uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: "Auto generate docs"

README.org

@@ -44,11 +44,15 @@ Requires *neovim 0.9.2+*.
 
 ** Link Highlighting by Hover
 
-   TODO
+   #+CAPTION: Example of link highlighting when a mouse hovers
+   #+NAME:    org-mouse-highlight-example
+   [[https://github.com/chipsenkbeil/org-mouse.nvim/assets/2481802/f0e475e8-ba8c-44dc-a81e-e44321415cc6]]
 
 ** Navigating Links by Click
 
-   TODO
+   #+CAPTION: Example of opening a link when a mouse clicks
+   #+NAME:    org-mouse-click-example
+   [[https://github.com/chipsenkbeil/org-mouse.nvim/assets/2481802/0644fd1b-437a-418a-937e-caf20eac945e]]
 
 * Configuration