Tool for automatically converting markdown to vimdoc format
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
README.md
md2vim.go
vimdoc.go

README.md

Md2Vim

Writing technical documentation for Vim extensions is not exciting; manually converting what you've just written in Markdown to vimdoc format is even less fun. I grew tired of having to do this repeatedly for my Vim-ArgWrap extension and finally formally solved this problem with a purpose-built tool. Maintainability, ease of use, and beautiful vimdoc output were primary considerations in Md2Vim's design.

Installation

If you already have the Go environment and toolchain set up, you can get the latest version by running:

$ go get github.com/FooSoft/md2vim

Otherwise, you can use the pre-built binaries for the platforms below:

Usage

Executing Md2Vim with the -help command line argument will trigger online help to be displayed. The list below provides a more detailed description of what the parameters do.

  • cols

    The number of columns used for laying out vimdoc files to make them look as good as possible with your content. Notice that file contents will not be wrapped to this value; this is purely for such things as horizontal rule widths and help tag positioning. This defaults to 80, but that's a bit too narrow for some people.

  • desc

    Vim help files are supposed to start with the following two fields on the first line:

    filename.txt Description of this help file's contents
    

    The first field is the filename of the generated vimdoc help file; the second is the description can you provide with this parameter.

  • norules

    By default, we generate horizontal rules above level 1-2 headings, as shown below:

    ================================================================================
    Level 1 Heading
    --------------------------------------------------------------------------------
    Level 2 Heading
    

    If you don't like the way it looks you can turn it off.

  • notoc

    If you don't wish to generate a table of contents you should set this flag to opt out. The table of contents lists all of the headings in the document and is always inserted before the beginning of document body.

  • pascal

    By default, all help tags get converted to lower case and space delimited words are joined with underscores.

    rigellians-how_to_cook_for_fourty_humans
    

    If you prefer the PascalCase way of doing things, set this flag and your output will look like this:

    Rigellians-HowToCookForFourtyHumans
    
  • tabs

    If you don't like four space tabs for some reason you can change it to something else with this parameter.

Screenshots

Markdown source file VimDoc destination file

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.