By Liang, Jian - last update: 2015/6
Document are expected to be updated with code change and managed by Perforce.
The documents are created using Vim+Vimwiki except the index page (index.html) that is maintained manually. Vim is a text editor widely used on Unix-like system, and Vimwiki is a plug-in of Vim for creating personal wiki.
Install Vim (version 7.3+) on Windows. On Linux, Vim is installed by default.
Get vimwiki on p4 in the same folder:
vimwiki-2-1-LJ.vba
This version is based on vimwiki 2.1 and has some modification by me.
To install vimwiki, open the vba file in Vim and run this command:
:so %
[Note] To generate our HTML document, please set this special vimwiki option in Vim:
" for vimwiki filetype plugin on let g:vimwiki_html_header_numbering=2 let g:vimwiki_folding='expr'
On Windows, please add it into the _vimrc file under the Vim folder.
For detail, please refer to Vimwiki main page.
The wiki file is just text file and is recommended to edit in Vim. Here's a simple template for our documents:
Press shortcut \wh in Vim. By default the HTML document is generated in the folder doc_html.
For detail usage of vimwiki, read the help document in Vim:
:h vimwiki
[Note]
File "style.css" is required to format the page. Please put it together with the HTML pages.