# Getting Started It is recommended to globally install the `docsify-cli` tool, which can simply build and preview local documentation. ```bash npm i docsify-cli -g ``` ## Initialize the project If you wish to create documentation in the `./docs` directory of your project, you can directly initialize it with `init`. ```bash docsify init ./docs ``` ## Start it Now After successful initialization, various files are created in the `./docs` directory - `index.html` Entry - `README.md` will be rendered as homepage content - `.nojekyll` to avoid GitHub Pages from neglecting files that begin with an underline Editing `docs/README.md` directly can update the content of the document, and of course you can[add more pages](zh-cn/more-pages.md)。 ## Local Preview You can easily preview the effect in real-time by enabling a local server by running `docsify serve`. Default access address: http://localhost:3000 。 ```bash docsify serve docs ``` ?> To learn more about the command-line tool usage, please refer to [docsify-cli documentation](https://github.com/docsifyjs/docsify-cli)。 ## Manual initialization If you dislike npm or find the installation of the tools to be too laborious, we can manually create the `index.html` file. *index.html* ```html
``` If Python is available on your system, you may also launch a static server to preview your website with relative ease. ```python2 cd docs && python -m SimpleHTTPServer 3000 ``` ```python3 cd docs && python -m http.server 3000 ``` ## Loading Tips The `Loading...` content will be presented upon initialization, and the prompt information can be customized. ```html