chore: Auto generate docs

chrisgrieser · Oct 16, 2023 · 8c13b5e · 8c13b5e
1 parent 0261648
commit 8c13b5e
Showing 1 changed file with 32 additions and 16 deletions.
diff --git a/doc/tinygit.txt b/doc/tinygit.txt
@@ -49,14 +49,18 @@ TABLE OF CONTENTS                     *tinygit-nvim-tinygit-table-of-contents*
 
 FEATURES                                       *tinygit-nvim-tinygit-features*
 
-- Smart-Commit: Open a popup to enter a commit message. If there are no staged changed, stages all changes before doing so (`git add -A`).
+- Smart-Commit: Open a popup to enter a commit message. If there are no staged
+    changed, stages all changes before doing so (`git add -A`).
 - Option to automatically open references GitHub issues in the browser after committing.
-- Commit Messages have syntax highlighting, indicators for commit message overlength <https://stackoverflow.com/questions/2290016/git-commit-messages-50-72-formatting>, and optionally enforce conventional commits keywords.
+- Commit Messages have syntax highlighting, indicators for commit message
+    overlength <https://stackoverflow.com/questions/2290016/git-commit-messages-50-72-formatting>,
+    and optionally enforce conventional commits keywords.
 - Option to run `git push` in a non-blocking manner after committing.
 - Quick amends.
 - Search issues & PRs. Open the selected issue or PR in the browser.
 - Open the GitHub URL of the current file or selection.
-- Search the file history for a string ("git pickaxe"), show results in a diff with filetype syntax highlighting.
+- Search the file history for a string ("git pickaxe"), show results in a diff
+    with filetype syntax highlighting.
 
 
 INSTALLATION                               *tinygit-nvim-tinygit-installation*
@@ -91,9 +95,11 @@ USAGE                                             *tinygit-nvim-tinygit-usage*
 
 SMART-COMMIT ~
 
-- Open a commit popup. If there are no staged changes, stage all changes (`git add -A`) before the commit.
-- Right now, only supports the commit subject line. Optionally runs `git push` afterward or opens references issues in the browser.
-- To use vim commands in the input field, set dressing.nvim’s `insert_only` to `false`.
+- Open a commit popup. If there are no staged changes, stage all changes (`git   add -A`) before the commit.
+- Right now, only supports the commit subject line. Optionally runs `git push`
+    afterward or opens references issues in the browser.
+- To use vim commands in the input field, set dressing.nvim’s `insert_only`
+    to `false`.
 
 >lua
     -- options default to `false`
@@ -116,9 +122,12 @@ SMART-COMMIT ~
 
 QUICK AMENDS ~
 
-- `amendOnlyMsg` just opens the commit popup to change the last commit message, and does not stage any changes.
-- `amendNoEdit` keeps the last commit message; if there are no staged changes, it stages all changes (`git add -A`).
-- Optionally runs `git push --force` afterward (only recommended for single-person repos).
+- `amendOnlyMsg` just opens the commit popup to change the last commit message,
+    and does not stage any changes.
+- `amendNoEdit` keeps the last commit message; if there are no staged changes,
+    it stages all changes (`git add -A`).
+- Optionally runs `git push --force` afterward (only recommended for
+    single-person repos).
 
 >lua
     -- options default to `false`
@@ -130,14 +139,15 @@ QUICK AMENDS ~
 GITHUB INTERACTION ~
 
 - Search issues & PRs. (Requires `curl`.)
-- The appearance of the selector is controlled by `dressing.nvim`. (You can configure `dressing` to use `telescope`.)
+- The appearance of the selector is controlled by `dressing.nvim`. (You can
+    configure `dressing` to use `telescope`.)
 
 >lua
     -- state: all|closed|open (default: all)
     -- type: all|issue|pr (default: all)
     require("tinygit").issuesAndPrs { type = "all", state = "all" }
 
-    -- alternative: if the word under the cursor is of the form `#123`, 
+    -- alternative: if the word under the cursor is of the form `#123`,
     -- just open that issue/PR
     require("tinygit").openIssueUnderCursor()
 <
@@ -211,7 +221,8 @@ The `setup` call is optional. These are the default settings:
         searchFileHistory = {
             diffPopupWidth = 0.8, -- float, 0 to 1
             diffPopupHeight = 0.8, -- float, 0 to 1
-        } 
+            diffPopupBorder = "single",
+        },
     }
 <
 
@@ -222,9 +233,14 @@ The `setup` call is optional. These are the default settings:
 
 NON-GOALS                                     *tinygit-nvim-tinygit-non-goals*
 
-- Become a full-fledged git client. Use neogit <https://github.com/NeogitOrg/neogit> for that.
-- Add features available in gitsigns.nvim <https://github.com/lewis6991/gitsigns.nvim>. `tinygit` is intended to complement `gitsigns.nvim` with some simple commands, not replace it.
-- UI Customization. Configure dressing.nvim <https://github.com/stevearc/dressing.nvim> for that.
+- Become a full-fledged git client. Use
+    neogit <https://github.com/NeogitOrg/neogit> for that.
+- Add features available in
+    gitsigns.nvim <https://github.com/lewis6991/gitsigns.nvim>. `tinygit` is
+    intended to complement `gitsigns.nvim` with some simple commands, not replace
+    it.
+- UI Customization. Configure
+    dressing.nvim <https://github.com/stevearc/dressing.nvim> for that.
 
 
 CREDITS                                         *tinygit-nvim-tinygit-credits*
@@ -245,7 +261,7 @@ Mastodon <https://pkm.social/@pseudometa> - ResearchGate
 <https://www.researchgate.net/profile/Christopher-Grieser> - LinkedIn
 <https://www.linkedin.com/in/christopher-grieser-ba693b17a/>
 
-**Buy Me a Coffee**
+
 
 Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>