Project standalone documentation #84
Description
As the project gets bigger, so does the README. It's hard to navigate now.
Although getting help from lein run --help is a nice way to look up options available, cannot cover all the topics not necessarily about the tool but probably related to how the tool is to be run in certain scenarios.
cljdoc is a nice autodoc for the library uploaded to the Clojars, yet it suffers from the same limitations as the embedded help.
All in all, a standalone website with the documentation is needed to cover:
- tool's basic help
- library's autodoc
- articles related to the tool's topic of interest (license types, what real-life scenarios require attention to what types of licenses, etc.)
The platforms for hosting static web pages to consider:
- Cljdoc (It seems extra articles are supported)
- GitHub Pages
- MkDocs
- ReadTheDocs
- ?