Github + Markdown = Viewdocs
For open source software, documentation is very important. From my own experience, I became convinced that writing good documentation is often even more important than writing tests.
When I outgrown the README on Github, I only considered 2 options for documentation: Github Pages and Read the Docs . Unfortunately, I have problems with both. Mostly, Read the Docs forces me to use reStructured Text, and Github Pages implies support for a separate branch and the use of a static page generator.
In fact, I would like to have something similar to Gist.io , just for my repository. Not finding anything suitable, I wrote it myself.
I call it Viewdocs . The service on the fly creates pages from markdown in the docs folder of your project. Installation is not required, just follow the conventions. Perhaps for you it already works, because Markdown in the docs folder is not such a rarity.
')
The default template was borrowed from Gist.io.
You can learn more at the Viewdocs website, which is based on Viewdocs. Or a small screencast introduction:
When I outgrown the README on Github, I only considered 2 options for documentation: Github Pages and Read the Docs . Unfortunately, I have problems with both. Mostly, Read the Docs forces me to use reStructured Text, and Github Pages implies support for a separate branch and the use of a static page generator.
In fact, I would like to have something similar to Gist.io , just for my repository. Not finding anything suitable, I wrote it myself.
I call it Viewdocs . The service on the fly creates pages from markdown in the docs folder of your project. Installation is not required, just follow the conventions. Perhaps for you it already works, because Markdown in the docs folder is not such a rarity.
')
The default template was borrowed from Gist.io.
You can learn more at the Viewdocs website, which is based on Viewdocs. Or a small screencast introduction:
Source: https://habr.com/ru/post/207870/
All Articles