https://github.com/luffah/vim-genhelp

Vim documentation tool for Vim scripts and plugins. Generate Helpfile and Readme.
https://github.com/luffah/vim-genhelp

helpfile vim vim-plugin vimdoc

Last synced: about 1 year ago
JSON representation

Vim documentation tool for Vim scripts and plugins. Generate Helpfile and Readme.

• Host: GitHub
• URL: https://github.com/luffah/vim-genhelp
• Owner: luffah
• License: other
• Created: 2018-06-04T10:00:35.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2020-12-12T16:51:12.000Z (over 5 years ago)
• Last Synced: 2025-02-10T03:24:23.953Z (over 1 year ago)
• Topics: helpfile, vim, vim-plugin, vimdoc
• Language: Vim script
• Homepage:
• Size: 9.77 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
```

      .--.                 .-. .-.      .-.

     / .-_\_  ___     ___  | | | | ___  | |

    | | |___|/ o \  ,'_  | | '-' |/ o \ | | .--.

     \ '-'|   \  '.| | | | | .-. | \  '.| | | o |

      '---'    '--''-' '-' '-' '-'  '--''--'| |'

                                            | |

                                            '-'

** genhelp.vim -- Helper script to generate vim help files **

License:     GPLv3

Last Change: 2019-07-01

```

GenHelp generate vim help file for the current script.

### HOW TO USE IT ?

`:GenHelp` 

    Generate an help file from the current file.

    Tag file will be written once the file is saved.

`:GenReadme` 

    Generate a simple readme from the current file.

### WHAT I HAVE TO DO BEFORE ?

To work with GenHelp, the vim script format shall be the following :

   " _filename_ -- _desc_

   " @Author:      _author_

   " @License:     _licence_

   " @Created:     _creation-date_

   " @Last Change: _modification-date_

   " @Revision:    _revision_

   " @Files

   "  ../plugin/_file_.vim

   "  ../autoload/_file_.vim

   "

   " @AsciiArt

   " _text_

   "

   " @Overview

   " _text_


   " Following properties can be located in any '@include' files

   " @Examples

   " _text_ : ```

   "     _codeblock_

   "```

   " @Fileformat g:_variablename_

   " _text_

   " @global g:_variablename_

   " _text_

   " @function _functionname_(_arguments_)

   " _text_

   " @command _commandname_ _arguments_

   " _text_

   " @usage _usecase_

   " _text_

   " @mapping _keys_

   " _text_