Converting your Markdown-docs into a fancy React-ish site.
Documate is a minimal static site generator that takes your Markdown-based code and outputs a whimsy React-ish site.
So we've been working on some Open Source projects and after all the struggles, we decided to have a website. Consequently, we needed to maintain the site somehow and we found it to be very clumsy and caused us a lot of maintainability issues. That aside, how could we possibly cater for different viewports? We thought of trying Docusaurus and/or other similar tools but they never met the standards of accessibility we needed.
The reason for using Markdown is simply because docs written in HTML, JSX, Handlebars or any other markup that uses angle brackets seem to be cluttery with all the unnecessary tags that remove brevity and make readability a pain. Documate puts developer experience into consideration.
Another bonus of using Markdown is that any GitHub docs of your previous projects (in Markdown) can be put into a site with Documate.
All you need is to run two commands and then you deploy. Although Documate can't deploy your builds for you, your builds are made production-ready and your readers can enjoy reading along.
documate startand view your docs locally in no time. Check Documate's README.md for more details on dependency versions.
Documate doesn't generate docs or static content from code comments. Instead, you can copy and paste your code comments into Markdown with a few formattings and your docs should ready to get documated.