README.md

Docsify for YunoHost

Read this README in other languages.

This package allows you to install Docsify quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

Docsify turns one or more Markdown files into a Website, with no build process required.

Features

• No statically built html files
• Simple and lightweight
• Smart full-text search plugin
• Multiple themes
• Useful plugin API
• Emoji support

Shipped version: 4.4.4~ynh2

Screenshots

Documentation and resources

• Official app website: https://docsify.js.org/
• Official admin documentation: https://docsify.js.org/#/?id=docsify
• Upstream app code repository: https://github.com/docsifyjs/docsify/
• YunoHost Store: https://apps.yunohost.org/app/docsify
• Report a bug: https://github.com/YunoHost-Apps/docsify_ynh/issues

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that:

sudo yunohost app install https://github.com/YunoHost-Apps/docsify_ynh/tree/testing --debug
or
sudo yunohost app upgrade docsify -u https://github.com/YunoHost-Apps/docsify_ynh/tree/testing --debug

More info regarding app packaging: https://yunohost.org/packaging_apps