A self hosted frontend for markdown files (ex. GitHub READMEs). Docual picks out your headings and sub-headings, and creates a sidebar for easy navigation. Docual also integrates a powerful search function.
Docual is perfect for documentation and informative content. It takes 5 minutes to setup and updates whenever you update the source markdown file wich can be stored anyware (as long as Docual can access it).
The programming language "Enkelt" keeps their documentation in a GitHub wiki and uses Docual as a frontend layer. Check it out here!
Clone this repo Copy the "docual" folder and paste it somewhere else.
Configure the site from the config files found in the /public folder (config.json and colors.css), or change the source of the site. Docual is powered by Vue.js.
You can test your site locally by first running npm install and then npm run serve, which will start a local server on (default) http://localhost:8080.
You can either host your page on a service like Netlify that offers automatic deploys for Vue.js apps, or you can host it anywere you can hot static webpages by running npm run build and then serving your site from the /dist folder.
Edvard Busck-Nielsen, Docual 2020.