alex/md2vim
1
Fork 0
Code Releases 1 Activity

Updating README

Browse Source
This commit is contained in:
Alex Yatskov 2015-08-19 18:19:43 +09:00
parent edf27f96cb
commit 99e7f72a8b
1 changed files with 6 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -53,18 +53,13 @@ $ md2vim \
doc/argwrap.txt
```
And here is the animation of it happening in a terminal window; notice the pretty help file layout Vim.
Below is a screenshot of the vimdoc file being generated by Md2Vim and displayed inside of Vim. The curious may also
wish to examine the [raw markdown input](https://raw.githubusercontent.com/FooSoft/vim-argwrap/master/README.md) and the
[raw vimdoc output](https://raw.githubusercontent.com/FooSoft/vim-argwrap/master/doc/argwrap.txt) used in this example
to get a better idea of how the markdown structure is transformed to vimdoc.
![](http://foosoft.net/projects/md2vim/img/demo.gif)
## Requirements ##
Md2Vim makes the reasonable assumption that your document headings are arranged in a single-root hierarchy for the
purposes of table of contents generation. As long as you have exactly one top level heading (usually the title of your
extension), with sub-headings following it (directions for installation, configurations, etc.) everything will look and
work great. If you don't want to follow this hierarchy in your help file, you can still use this tool as long as you
disable table of contents generation.
## Usage ##
Executing Md2Vim with the -help command line argument will trigger online help to be displayed. The list below provides
@ -101,9 +96,8 @@ a more detailed description of what the parameters do.
* `notoc`
If you don't want to generate a table of contents you can specify this argument. The table of contents lists all of
the child headings underneath the primary heading; it is always inserted right before the second heading in your
document.
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`