Currently I tend to write most documents using markdown and as of recently I was writing technical documentation all in markdown and needed a way to take the markdown and convert it to a self container HTML document that I would share with others. I had looked on Github and found several blogging engines built around markdown files being converted to html and served via express. That isn't what I needed. So I wrote DocDown as a simple personal tool to help with my productivity. Maybe it will help you as well.
Well you will need nodejs and npm, if you haven't used those yet go find a tutorial and get started :)
Once you have npm install the dependencies
Currently there is only one layout and all your markdown must go in the myMarkdownSource. I was in a hurry building this so I haven't written the code to do command line options parsing. Sorry had a deadline and just needed this to work :)
So in the pipe is the ability to pass file handlers into the app, and maybe a bash script to help harness the app or if I figure out how to package into npm I can make it entirely standalone.
FAQs
A simple JSDoc to Markdown documentation generator.
The npm package docdown receives a total of 1,235 weekly downloads. As such, docdown popularity was classified as popular.
We found that docdown demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
