atensi / docsify-documentation-template

A template to start writing documentation fast with docsify

Docsify Documentation Template

How to start

• Install nodejs
• Launch the following command to install docsify:

npm i docsify-cli -g

• Run the server with the following command:

docsify serve docs/

Note

You can also run the server by using the preview.sh script:

./preview.sh

Overview

Here is an overview of this theme:

• Homepage (Light theme)

• Dark Theme

• Navbar (open level)

Contributing

The contributions are closed for the time being. I do not plan to modify it for now. It was designed as a template. You can fork it and adapt it to your needs.

Special thanks

I want to thank everyone working on the following projects (in no special order):

• The docsify team for docsify
• JP Erasmus for docsify-copy-code
• Boopathi Kumar for the docsify-darklight-theme
• imyelo for docsify-pagination
• Fabian Zankl for docsify-plugin-flexible-alerts
• iPeng6 for docsify-sidebar-collapse
• prismjs (for syntax highlighting)