From 99e7f72a8b38ef6e4f290b371f7870535c2e1241 Mon Sep 17 00:00:00 2001 From: Alex Yatskov Date: Wed, 19 Aug 2015 18:19:43 +0900 Subject: [PATCH] Updating README --- README.md | 18 ++++++------------ 1 file changed, 6 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 332deab..29e7007 100644 --- a/README.md +++ b/README.md @@ -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`