# docsify > A magical documentation site generator. ## Features - Easy and lightweight - Custom themes - No build ## Quick Start ### Create a project First create a project, then create a `docs` folder ```shell mkdir my-project && cd my-project mkdir docs && cd docs ``` ### Create entry file Create a `404.html` file ```html
``` Create `README.md` as the main page ``` # Title ## balabala ``` ### Deploy! Push and open the **GitHub Pages** feature ![image](https://cloud.githubusercontent.com/assets/7565692/20639058/e65e6d22-b3f3-11e6-9b8b-6309c89826f2.png) ## CLI Easy to setup and preivew a docs. ### Install ```shell npm i docsify-cli -g ``` ### Setup Setup a boilerplate docs ```shell docsify init docs ``` ### Preview Preview and serve your docs using ```shell docsify serve docs ``` Read more [docsify-cli](https://github.com/QingWei-Li/docsify-cli) ## Themes Currently available `vue.css` and `buble.css` ```html ``` Minified files ```html ``` ## More ### Multiple pages If you need other pages, directly create the markdown file, such as `guide.md` is `/guide`. ### Navbar Code in `404.html` ```html ``` ### Options #### repo Display the [GitHub Corner](http://tholman.com/github-corners/) widget. ```html ``` #### max-level Toc level. ```html ``` #### el Root element. ```html ```