From a029d3a982279e73ea9fdf4e4c7303e4f7a72ca5 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]" <github-actions[bot]@users.noreply.github.com>
Date: Sun, 19 Jan 2025 11:59:22 +0000
Subject: [PATCH] chore(doc): auto generate docs

---
 doc/guard.nvim.txt | 60 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 doc/guard.nvim.txt

diff --git a/doc/guard.nvim.txt b/doc/guard.nvim.txt
new file mode 100644
index 0000000..34cc920
--- /dev/null
+++ b/doc/guard.nvim.txt
@@ -0,0 +1,60 @@
+*guard.nvim.txt*          For NVIM v0.8.0         Last change: 2025 January 19
+
+==============================================================================
+Table of Contents                               *guard.nvim-table-of-contents*
+
+1. nvim-plugin-template                      |guard.nvim-nvim-plugin-template|
+  - Usage                              |guard.nvim-nvim-plugin-template-usage|
+  - Format                            |guard.nvim-nvim-plugin-template-format|
+  - Test                                |guard.nvim-nvim-plugin-template-test|
+  - CI                                    |guard.nvim-nvim-plugin-template-ci|
+  - More                                |guard.nvim-nvim-plugin-template-more|
+  - License MIT                  |guard.nvim-nvim-plugin-template-license-mit|
+
+==============================================================================
+1. nvim-plugin-template                      *guard.nvim-nvim-plugin-template*
+
+Neovim plugin template; includes automatic documentation generation from
+README, integration tests with Busted, and linting with Stylua
+
+
+USAGE                                  *guard.nvim-nvim-plugin-template-usage*
+
+1. Click `use this template` button generate a repo on your github.
+2. Clone your plugin repo. Open terminal then cd plugin directory.
+3. Run `python3 rename.py your-plugin-name`. This will replace all `nvim-plugin-template` to your `plugin-name`.
+Then it will prompt you input `y` or `n` to remove example codes in `init.lua` and
+`test/plugin_spec.lua`. If you are familiar this repo just input `y`. If you are looking at this template for the first time I suggest you inspect the contents. After this step `rename.py` will also auto-remove.
+
+Now you have a clean plugin environment. Enjoy!
+
+
+FORMAT                                *guard.nvim-nvim-plugin-template-format*
+
+The CI uses `stylua` to format the code; customize the formatting by editing
+`.stylua.toml`.
+
+
+TEST                                    *guard.nvim-nvim-plugin-template-test*
+
+See Running tests locally
+<https://github.com/nvim-neorocks/nvim-busted-action?tab=readme-ov-file#running-tests-locally>
+
+
+CI                                        *guard.nvim-nvim-plugin-template-ci*
+
+- Auto generates doc from README.
+- Runs the nvim-busted-action <https://github.com/nvim-neorocks/nvim-busted-action> for test.
+- Lints with `stylua`.
+
+
+MORE                                    *guard.nvim-nvim-plugin-template-more*
+
+To see this template in action, take a look at my other plugins.
+
+
+LICENSE MIT                      *guard.nvim-nvim-plugin-template-license-mit*
+
+Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
+
+vim:tw=78:ts=8:noet:ft=help:norl: