# Quick start It is recommended to install `docsify-cli` globally, which helps initializing and previewing the website locally. ```bash npm i docsify-cli -g ``` ## Initialize If you want to write the documentation in the `./docs` subdirectory, you can use the `init` command. ```bash docsify init ./docs ``` ## Writing content After the `init` is complete, you can see the file list in the `./docs` subdirectory. * `index.html` as the entry file * `README.md` as the home page * `.nojekyll` prevents GitHub Pages from ignoring files that begin with an underscore You can easily update the documentation in `./docs/README.md`, of course you can add [more pages](more-pages.md). ## Preview your site Run the local server with `docsify serve`. You can preview your site in your browser on `http://localhost:3000`. ```bash docsify serve docs ``` ?> For more use cases of `docsify-cli`, head over to the [docsify-cli documentation](https://github.com/QingWei-Li/docsify-cli). ## Manual initialization If you don't like `npm` or have trouble installing the tool, you can manually create `index.html`: ```html
``` If you installed python on your system, you can easily use it to run a static server to preview your site. ```bash cd docs && python -m SimpleHTTPServer 3000 ``` ## Loading dialog If you want, you can show a loading dialog before docsify starts to render your documentation: ```html
Please wait...
``` You should set the `data-app` attribute if you changed `el`: ```html
Please wait...
``` Compare [el configuration](configuration.md#el).