I am lazy! Kinda... ๐ด
Do you find yourself spending too much time adding new pages to your documentation website? If so, you're not alone! Maintaining documentation can be a tedious task, involving copying and pasting files and writing markdown content. So I have created a simple markdown documentation tool, Rino Docs.
What is Rino Docs? ๐คช
Rino Docs is a simple markdown documentation tool powered by Rino.js. It simplifies the process of adding new documentation pages and enables you to customize the design of your documentation website.
Rino Docs reads markdown files from the ./src/mds directory and generates HTML pages in the ./dist directory. What sets it apart is its ability to automatically generate a sidebar component with a list of links for all your documentation pages. No more manual linking!
Installation:
npm create rinodocs@latest
Development & Build:
npm run dev
Sitemap generation:
npm run sitemap
Organizing Sidebar Links ๐ง
You might wonder how the links in the sidebar are ordered. It's quite simple! Just add a number at the beginning of your markdown file names. Rino Docs will automatically sort the links based on the numeric order of the file names. For example, naming a file as '1. Home' will place it at the top of the sidebar.
Customizing Your Documentation Website โ๏ธ
Want to customize the template of your documentation website? You have the flexibility to do so. Simply edit the files located in ./src/pages/ and ./src/components/. If you need to support multiple languages or make any other adjustments, feel free to edit any files within the project.
For the last ๐
Don't let documentation drain your time and energy. Give Rino Docs a try and simplify your documentation workflow today!
Top comments (0)