Super Simple Markdown Docs
npm install ssmdocs.md files:
docsrc/
|-- Service Foo/
| |-- index.md
| |-- API.md
| |-- How to use.md
|-- Other things/
| |-- Subfolder A/
| | |-- index.md
| | |-- topic 1.md
| | |-- topic 2.md
| |-- Subfolder B/
| | |-- topic 3.md
| | |-- topic 4.md
node ssmd.js --content=docsrc --s3bucket=docs.example.com --s3id=ABC123 --s3key=secretkey
dist to a static file hoster of your choice.
ssmd is capable of merging together different trees, without any special coordination on your part. It's as though all the directory trees are merged before generating the HTML. No need to coordinate your CI jobs. Every repo can merge and upload it's contents independently. You must use the S3 uploader in order for this to work.
index.md file to create content for a directory. If you don't create an index.md file, then the directory will just be a node in the tree, but it won't have any content.
API.md. Then, create an API entry point by creating an h1* item in markdown, that starts with the HTTP method of the API, for example: # POST /path/to/api?key=value