node-event-storage icon indicating copy to clipboard operation
node-event-storage copied to clipboard

Improve documentation

Open albe opened this issue 8 years ago • 2 comments

Currently the documentation is relatively unstructured and misses proper explanation/listing of all available options. Also some more practical usage examples with explanations would do good.

albe avatar Aug 18 '17 08:08 albe

Check out https://docusaurus.io/docs/en/next/tutorial-setup for documentation

albe avatar Jan 23 '20 17:01 albe

Decided for readthedocs.io now using mkdocs renderer. Docs are written as md inside the docs folder.

https://node-event-storage.readthedocs.io/en/latest/

See https://www.mkdocs.org/user-guide/writing-your-docs/ for more information, the configuration is inside the mkdocs.yml in the root.

albe avatar Mar 04 '20 11:03 albe