# docsify [![Build Status](https://travis-ci.org/QingWei-Li/docsify.svg?branch=master)](https://travis-ci.org/QingWei-Li/docsify) [![npm](https://img.shields.io/npm/v/docsify.svg)](https://www.npmjs.com/package/docsify) >🃏 A magical documentation site generator. ## Links - [Documentation](https://docsify.js.org) - [CLI](https://github.com/QingWei-Li/docsify-cli) ## Features - Easy and lightweight - Custom themes - No build ## Quick start Create a `404.html` and `README.md` into `/docs`. 404.html ```html
``` Or Create a `index.html` and using `hash router`. index.html ```html
``` ## Showcase These open-source projects are using docsify to generate their sites. Pull requests welcome : ) - [docsify](https://docsify.js.org) - A magical documentation site generator. - [Snipaste](https://docs.snipaste.com/) - A new way to boost your productivity. ## How to contribute - Fork it! - Run `npm i && npm run dev` - open `localhost:3000` ## License MIT ## Support on Beerpay Hey dude! Help me out for a couple of :beers:! [![Beerpay](https://beerpay.io/QingWei-Li/docsify/badge.svg?style=beer-square)](https://beerpay.io/QingWei-Li/docsify) [![Beerpay](https://beerpay.io/QingWei-Li/docsify/make-wish.svg?style=flat-square)](https://beerpay.io/QingWei-Li/docsify?focus=wish)