docs: add vimdoc and workflow (scottmckendry#5)

* docs: add vimdoc workflow * chore: auto-generate vimdoc --------- Co-authored-by: scottmckendry <[email protected]>
ianchesal · Dec 28, 2023 · 329bac4 · 329bac4
1 parent 2988070
commit 329bac4
Show file tree

Hide file tree

Showing 2 changed files with 101 additions and 0 deletions.
diff --git a/.github/workflows/vimdoc.yml b/.github/workflows/vimdoc.yml
@@ -0,0 +1,21 @@
+name: Generate VimDoc
+on:
+    push:
+
+jobs:
+    generate-doc:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+            - run: git pull
+            - name: panvimdoc
+              uses: kdheepak/panvimdoc@main
+              with:
+                  vimdoc: cyberdream.nvim
+                  version: "Neovim >= 0.9.0"
+                  demojify: true
+                  treesitter: true
+            - name: Push changes
+              uses: stefanzweifel/git-auto-commit-action@v4
+              with:
+                  commit_message: "chore: auto-generate vimdoc"
diff --git a/doc/cyberdream.nvim.txt b/doc/cyberdream.nvim.txt
@@ -0,0 +1,80 @@
+*cyberdream.nvim.txt*     For Neovim >= 0.9.0    Last change: 2023 December 28
+
+==============================================================================
+Table of Contents                          *cyberdream.nvim-table-of-contents*
+
+  - Features                                        |cyberdream.nvim-features|
+  - Installation                                |cyberdream.nvim-installation|
+  - Contributing                                |cyberdream.nvim-contributing|
+
+A high-contrast, futuristic & vibrant theme for neovim
+
+
+
+
+
+
+
+
+FEATURES                                            *cyberdream.nvim-features*
+
+- **Transparency-first design** - all design decisions are made with transparency in mind
+- **High contrast** - Colours have been carefully chosen to be cohesive and easy on the eyes while still being easy to distinguish
+
+Supported Plugins ~
+
+ alpha-nvim lazy.nvim leap.nvim lualine.nvim nvim-cmp nvim-treesitter telescope.nvim which-key.nvim
+INSTALLATION                                    *cyberdream.nvim-installation*
+
+Lazy:
+
+>lua
+    {
+        "scottmckendry/cyberdream.nvim",
+        lazy = false,
+        priority = 1000,
+        config = function()
+            require("cyberdream").setup({
+                transparent = true, -- enable transparent background
+                italic_comments = true, -- italicize comments
+                hide_fillchars = true, -- replace all fillchars with ' ' for the ultimate clean look
+            })
+            vim.cmd("colorscheme cyberdream") -- set the colorscheme
+        end,
+    }
+<
+
+Lualine (optional):
+
+>lua
+    {
+        local cyberdream = require("lualine.themes.cyberdream")
+        require("lualine").setup({
+            -- ... other config
+            options = {
+                theme = "cyberdream",
+            },
+            -- ... other config
+        })
+    }
+<
+
+See my personal lualine config here
+<https://github.com/scottmckendry/Windots/blob/main/nvim/lua/plugins/lualine.lua>
+for an example.
+
+
+CONTRIBUTING                                    *cyberdream.nvim-contributing*
+
+Pull requests are welcome. If a plugin you use is not supported, please open an
+issue and I’ll try to add support for it. If you have any suggestions or
+feedback, please open an issue.
+
+==============================================================================
+1. Links                                               *cyberdream.nvim-links*
+
+1. *cyberdream-screenshot*: https://github.com/scottmckendry/cyberdream.nvim/assets/39483124/18004b97-8677-4ec1-afb8-76ea5c49a7bd
+
+Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
+
+vim:tw=78:ts=8:noet:ft=help:norl: