-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #59 from mikesmithgh/panvimdoc-readme-to-vimdoc
docs: add workflow to convert README to vimdoc readme to vimdoc
- Loading branch information
Showing
3 changed files
with
270 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| name: panvimdoc | ||
| on: | ||
| push: | ||
| branches: | ||
| - '**' | ||
| paths: | ||
| - README.md | ||
| - .github/workflows/panvimdoc.yml | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| vimdoc: | ||
| runs-on: ubuntu-latest | ||
| name: generate vimdoc | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
|
|
||
| - name: panvimdoc | ||
| uses: kdheepak/panvimdoc@main | ||
| with: | ||
| vimdoc: hardtime.nvim | ||
| pandoc: "README.md" | ||
| version: "NVIM v0.7+" | ||
| toc: true | ||
| demojify: true | ||
| dedupsubheadings: false | ||
| treesitter: true | ||
|
|
||
| - uses: stefanzweifel/git-auto-commit-action@v4 | ||
| with: | ||
| branch: ${{ github.head_ref }} | ||
| commit_message: "chore(build): auto-generate vimdoc" | ||
| commit_user_name: "github-actions[bot]" | ||
| commit_user_email: "github-actions[bot]@users.noreply.github.com" | ||
| commit_author: "github-actions[bot] <github-actions[bot]@users.noreply.github.com>" | ||
| file_pattern: doc/*.txt | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,203 @@ | ||
| *hardtime.nvim.txt* For NVIM v0.7+ Last change: 2023 October 04 | ||
|
|
||
| ============================================================================== | ||
| Table of Contents *hardtime.nvim-table-of-contents* | ||
|
|
||
| - Introduction |hardtime.nvim-introduction| | ||
| - Features |hardtime.nvim-features| | ||
| - Requirements |hardtime.nvim-requirements| | ||
| - Installation |hardtime.nvim-installation| | ||
| - Usage |hardtime.nvim-usage| | ||
| - Configuration |hardtime.nvim-configuration| | ||
| - Contributing |hardtime.nvim-contributing| | ||
|
|
||
| INTRODUCTION *hardtime.nvim-introduction* | ||
|
|
||
| A Neovim plugin helping you establish good command workflow and habit | ||
|
|
||
|
|
||
| FEATURES *hardtime.nvim-features* | ||
|
|
||
| - Block repeated keys within a period of time | ||
| - Print hints about better commands eg: Use `ci"` instead of `di"i` | ||
| - Customizable options for restricted keys, disabled keys, etc. | ||
| - Get report for your most common bad habits for improvement | ||
|
|
||
| Recommended workflow: | ||
|
|
||
| 1. Avoid using the mouse and arrow keys if they are not at the home row of your keyboard. | ||
| 2. Use relative jump (eg: `5j` `12-`) for vertical movement within the screen. | ||
| 3. Use `CTRL-U` `CTRL-D` `CTRL-B` `CTRL-F` `gg` `G` for vertical movement outside the screen. | ||
| 4. Use word-motion (`w` `W` `b` `B` `e` `E` `ge` `gE`) for short-distance horizontal movement. | ||
| 5. Use `f` `F` `t` `T` `,` `;` `0` `^` `$` for medium to long-distance horizontal movement. | ||
| 6. Use operator + motion/text-object (eg: `ci{` `y5j` `dap`) whenever possible. | ||
| 7. Use `%` and square bracket commands (see |[|) to jump between brackets. | ||
|
|
||
| Learn more in this blog post <https://m4xshen.dev/posts/vim-command-workflow/> | ||
|
|
||
|
|
||
| REQUIREMENTS *hardtime.nvim-requirements* | ||
|
|
||
| - Neovim >= v0.7.0 <https://github.com/neovim/neovim/releases/tag/v0.7.0> | ||
|
|
||
|
|
||
| INSTALLATION *hardtime.nvim-installation* | ||
|
|
||
| 1. Install via your favorite package manager. | ||
|
|
||
| >lua | ||
| -- lazy.nvim | ||
| { | ||
| "m4xshen/hardtime.nvim", | ||
| dependencies = { "MunifTanjim/nui.nvim", "nvim-lua/plenary.nvim" }, | ||
| opts = {} | ||
| }, | ||
| < | ||
|
|
||
| 1. Setup the plugin in your `init.lua`. This step is not needed with lazy.nvim if `opts` is set as above. | ||
|
|
||
| >lua | ||
| require("hardtime").setup() | ||
| < | ||
|
|
||
| If you want to see the hint messages in insert and visual mode, set the | ||
| `'showmode'` to false. | ||
|
|
||
| But if you want to see both the hint message and current mode you can setup | ||
| with one of the following methods: | ||
|
|
||
| - Display the mode on status line and set `'showmode'` to false. You can do this with some statusline plugin such as lualine.nvim. | ||
| - Set the `'cmdheight'` to 2 so that the hint message won’t be replaced by mode message. | ||
| - Use nvim-notify to display hint messages on the right top corner instead of commandline. | ||
|
|
||
|
|
||
| USAGE *hardtime.nvim-usage* | ||
|
|
||
| hardtime.nvim is enabled by default. You can change its state with the | ||
| following commands: | ||
|
|
||
| - `:Hardtime enable` enable hardtime.nvim | ||
| - `:Hardtime disable` disable hardtime.nvim | ||
| - `:Hardtime toggle` toggle hardtime.nvim | ||
|
|
||
| You can view the most frequently seen hints with `:Hardtime report`. | ||
|
|
||
| Your log file is at `~/.cache/nvim/hardtime.nvim.log`. | ||
|
|
||
|
|
||
| CONFIGURATION *hardtime.nvim-configuration* | ||
|
|
||
| You can pass your config table into the `setup()` function or `opts` if you use | ||
| lazy.nvim. | ||
|
|
||
| If the option is a boolean, number, or array, your value will overwrite the | ||
| default configuration. | ||
|
|
||
| Example: | ||
|
|
||
| >lua | ||
| -- Add "oil" to the disabled_filetypes | ||
| disabled_filetypes = { "qf", "netrw", "NvimTree", "lazy", "mason", "oil" }, | ||
| < | ||
|
|
||
| If the option is a table with a `key = value` pair, your value will overwrite | ||
| the default if the key exists, and the pair will be appended to the default | ||
| configuration if the key doesn’t exist. You can set `key = {}` to remove the | ||
| default key-value pair. | ||
|
|
||
| Example: | ||
|
|
||
| >lua | ||
| -- Remove <Up> keys and append <Space> to the disabled_keys | ||
| disabled_keys = { | ||
| ["<Up>"] = {}, | ||
| ["<Space>"] = { "n", "x" }, | ||
| }, | ||
| < | ||
|
|
||
|
|
||
| OPTIONS ~ | ||
|
|
||
| -------------------------------------------------------------------------------------------------------- | ||
| Option Name Type Default Valuae Meaning | ||
| --------------------- --------------------- -------------------- --------------------------------------- | ||
| max_time number 1000 Maximum time (in milliseconds) to | ||
| consider key presses as repeated. | ||
|
|
||
| max_count number 2 Maximum count of repeated key presses | ||
| allowed within the max_time period. | ||
|
|
||
| disable_mouse boolean true Disable mouse support. | ||
|
|
||
| hint boolean true Enable hint messages for better | ||
| commands. | ||
|
|
||
| notification boolean true Enable notification messages for | ||
| restricted and disabled keys. | ||
|
|
||
| allow_different_key boolean false Allow different keys to reset the | ||
| count. | ||
|
|
||
| enabled boolean true Whether the plugin is enabled by | ||
| default or not. | ||
|
|
||
| resetting_keys table of See Config Keys in what modes that reset the | ||
| strings/table pair count. | ||
|
|
||
| restricted_keys table of See Config Keys in what modes triggering the count | ||
| strings/table pair mechanism. | ||
|
|
||
| restriction_mode string "block" The behavior when restricted_keys | ||
| ("block" or "hint") trigger count mechanism. | ||
|
|
||
| disabled_keys table of See Config Keys in what modes are disabled. | ||
| strings/table pair | ||
|
|
||
| disabled_filetypes table of strings See Config hardtime.nvim is disabled under these | ||
| filetypes. | ||
|
|
||
| hints table See Config key is a string pattern you want to | ||
| match, value is a table of hint message | ||
| and pattern length. Learn more about | ||
| Lua string pattern. | ||
| -------------------------------------------------------------------------------------------------------- | ||
|
|
||
| HINTS EXAMPLE ~ | ||
|
|
||
| These are two default hints: | ||
|
|
||
| >lua | ||
| hints = { | ||
| ["k%^"] = { | ||
| message = function() | ||
| return "Use - instead of k^" -- return the hint message you want to display | ||
| end, | ||
| length = 2, -- the length of actual key strokes that matches this pattern | ||
| }, | ||
| ["d[tTfF].i"] = { -- this matches d + {t/T/f/F} + {any character} + i | ||
| message = function(keys) -- keys is a string of key strokes that matches the pattern | ||
| return "Use " .. "c" .. keys:sub(2, 3) .. " instead of " .. keys | ||
| -- example: Use ct( instead of dt(i | ||
| end, | ||
| length = 4, | ||
| }, | ||
| } | ||
| < | ||
|
|
||
| Check out some examples of custom hint in discussion | ||
| <https://github.com/m4xshen/hardtime.nvim/discussions/categories/custom-hints>! | ||
|
|
||
|
|
||
| DEFAULT CONFIG ~ | ||
|
|
||
|
|
||
| CONTRIBUTING *hardtime.nvim-contributing* | ||
|
|
||
| hardtime.nvim is participating in Hacktoberfest 2023! | ||
|
|
||
| Pleaseread CONTRIBUTING.md | ||
| <https://github.com/m4xshen/hardtime.nvim/blob/main/CONTRIBUTING.md>. | ||
|
|
||
| Generated by panvimdoc <https://github.com/kdheepak/panvimdoc> | ||
|
|
||
| vim:tw=78:ts=8:noet:ft=help:norl: |