Build a documentation website using markdown.
You can see the documentation website of this repository at https://hogenttin.github.io/hogent-docsify/ . Play with it to see what it can do!
Edit, add or delete your markdown files in the docs directory, and open index.html in your webbrowser. That's all to get started! 🚀
If you want to edit the sidebar, then just edit _sidebar.md .
Docsify allows you to start up a live preview, so you can instantly see how your slides look like whilst editing the markdown files.
-
Install nodejs .
-
Install docsify-cli :
npm install --global docsify-cli -
Start up the live preview:
docsify serve docs
If you hide the sidebar, you can easily create PDF's using your webbrowser's Print to PDF function.
💡 You don't have to change these files or settings if you want to keep things simple. In that case, just ignore this section.
If you want another theme, you can change edit the theme.css header tag in index.html to point to another CSS file. You can also use an existing links like https://hogenttin.github.io/hogent-docsify/theme.css .
If you copy or fork this repo, but always want to keep the theme of your documentation website at any time automatically in sync with this repo, you can ... .
- Set the
themelink tag in index.html to the URL https://hogenttin.github.io/hogent-revealmd/_assets/theme.css . - Delete the local CSS file.
docsify options
You can add them to index.html .
You can add additional functionality using Docsify plugins. These can be enabled by editing index.html . E.g., the Mermaid plugin for drawing graphs is added in this repo as an example on how to do it.
💡 You don't need this if you want to keep things simple. In that case, just ignore this section. Otherwise, it's here if you want an example.
This repo automatically builds the website and pushes them to https://hogenttin.github.io/hogent-docsify/ whenever a commit is pushed to the main branch. This is done using using GitHub actions . You can find the workflow in the .github folder.
An editorconfig config has been added in .editorconfig .
A prettier config has been added in .prettierrc.json5 .
A markdownlint config has been added in .markdownlint.jsonc .