Hi guys,
I just created an demo for libstoragemgmt documentation:
http://cathay4t.github.io/libstoragemgmt-doc/
# Just copy existing sf.net wiki files to github.
Features:
1. Use markdown file and git repo, codes:
https://github.com/cathay4t/libstoragemgmt-doc
2. It could integrate to upstream git repo with 'gh-pages' branch.
# We need discuss on "two repo vs one repo"
# Some document like 'known issues' might not link to code
# change(like SMI-S provider bugs). So I prefer to using
# separate git like 'libstoragemgmt-doc'.
3. Use GitHub Flavored Markdown.[1]
3. It could make a quit good front page for libstoragemgmt
project.
With some html/css coding care(the _layouts/default.html), of source.
Issues:
1. Cannot auto generate TOC(Table of Content).
https://github.com/isaacs/github/issues/215
Workaround:
manually generated table of contents
Check this page for demo:
http://cathay4t.github.io/libstoragemgmt-doc/doc/quick_user_guide
2. A lot TODO in markdown files. :)
3. My bad English. :(
I also intend to use markdown file to manually code down all C API and
Python API in human friendly way.
Any comments and suggestions.
[1]: https://help.github.com/articles/github-flavored-markdown/
--
Gris Ge
signature.asc
Description: Digital signature
------------------------------------------------------------------------------ Dive into the World of Parallel Programming The Go Parallel Website, sponsored by Intel and developed in partnership with Slashdot Media, is your hub for all things parallel software development, from weekly thought leadership blogs to news, videos, case studies, tutorials and more. Take a look and join the conversation now. http://goparallel.sourceforge.net/
_______________________________________________ Libstoragemgmt-devel mailing list Libstoragemgmt-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/libstoragemgmt-devel
