Update README
This commit is contained in:
parent
80f0215d74
commit
359bdc63b7
30
README.md
30
README.md
@ -6,9 +6,8 @@ convert what you've just written in [Markdown](https://daringfireball.net/projec
|
|||||||
over and over for my [ArgWrap](/projects/argwrap/) extension, I decided to formally solve this problem for myself and
|
over and over for my [ArgWrap](/projects/argwrap/) extension, I decided to formally solve this problem for myself and
|
||||||
others, creating the Md2Vim converter tool.
|
others, creating the Md2Vim converter tool.
|
||||||
|
|
||||||
Md2Vim is implemented in [Golang](https://golang.org/) as a custom renderer for the
|
Md2Vim is implemented in Golang as a custom renderer for the [blackfriday](https://github.com/russross/blackfriday)
|
||||||
[blackfriday](https://github.com/russross/blackfriday) Markdown processor. Maintainability, ease of use, and beautiful
|
Markdown processor. Maintainability, ease of use, and beautiful vimdoc output were primary considerations in its design.
|
||||||
vimdoc output were primary considerations in its design.
|
|
||||||
|
|
||||||
## Installation ##
|
## Installation ##
|
||||||
|
|
||||||
@ -25,26 +24,6 @@ Otherwise, you can use the pre-built binaries for the platforms below:
|
|||||||
* [md2vim_windows_386.zip](http://dl.foosoft.net/md2vim/md2vim_windows_386.zip)
|
* [md2vim_windows_386.zip](http://dl.foosoft.net/md2vim/md2vim_windows_386.zip)
|
||||||
* [md2vim_windows_amd64.zip](http://dl.foosoft.net/md2vim/md2vim_windows_amd64.zip)
|
* [md2vim_windows_amd64.zip](http://dl.foosoft.net/md2vim/md2vim_windows_amd64.zip)
|
||||||
|
|
||||||
## Example ##
|
|
||||||
|
|
||||||
Let's generate the documentation for [ArgWrap](/projects/argwrap/) by executing the command shown below (split into
|
|
||||||
multiple lines due to length considerations):
|
|
||||||
|
|
||||||
```
|
|
||||||
$ md2vim \
|
|
||||||
-desc "Wrap and unwrap function arguments, lists, and dictionaries in Vim" \
|
|
||||||
-cols=120 \
|
|
||||||
README.md \
|
|
||||||
doc/argwrap.txt
|
|
||||||
```
|
|
||||||
|
|
||||||
Below is an animation 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)
|
|
||||||
|
|
||||||
## Usage ##
|
## Usage ##
|
||||||
|
|
||||||
Executing Md2Vim with the -help command line argument will trigger online help to be displayed. The list below provides
|
Executing Md2Vim with the -help command line argument will trigger online help to be displayed. The list below provides
|
||||||
@ -101,3 +80,8 @@ a more detailed description of what the parameters do.
|
|||||||
* **tabs**
|
* **tabs**
|
||||||
|
|
||||||
If you don't like four space tabs for some reason you can change it to something else with this parameter.
|
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](img/markdown-thumb.png)](img/markdown.png)
|
||||||
|
[![VimDoc destination file](img/vimdoc-thumb.png)](img/vimdoc.png)
|
||||||
|
BIN
img/markdown-thumb.png
Normal file
BIN
img/markdown-thumb.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 15 KiB |
BIN
img/markdown.png
Normal file
BIN
img/markdown.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 39 KiB |
BIN
img/vimdoc-thumb.png
Normal file
BIN
img/vimdoc-thumb.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 14 KiB |
BIN
img/vimdoc.png
Normal file
BIN
img/vimdoc.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 37 KiB |
Loading…
Reference in New Issue
Block a user