mirror of
https://github.com/docsifyjs/docsify.git
synced 2025-12-08 19:55:52 +00:00
4ae87bb18b
* Update JS build - Change rollup build from API to config file - Change output dir from lib to dist - Update lib to dist path in related files - Update dependencies - Add banner comment to bundles - Add unminified plugin bundles * Update docs with v5 version lock and dist path * Update docs to reference minified themes * Clean up docs * Update CSS build - Change CSS build from API to CLI - Change output dir from lib to dist - Update lib to dist path in related files - Update dependencies - Add sourcemaps * Update dependencies * Clean up package.json and add keywords * Fix rimraf globs on Windows * Fix PostCSS CLI glob on Windows * Update test-related dependencies * Update emoji * Add engines prop to package.json
129 lines
3.4 KiB
Markdown
129 lines
3.4 KiB
Markdown
# 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/docsifyjs/docsify-cli).
|
|
|
|
## Manual initialization
|
|
|
|
If you don't like `npm` or have trouble installing the tool, you can manually create `index.html`:
|
|
|
|
<!-- prettier-ignore -->
|
|
```html
|
|
<!-- index.html -->
|
|
|
|
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
|
<meta charset="UTF-8" />
|
|
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@5/themes/vue.min.css" />
|
|
</head>
|
|
<body>
|
|
<div id="app"></div>
|
|
<script>
|
|
window.$docsify = {
|
|
//...
|
|
};
|
|
</script>
|
|
<script src="//cdn.jsdelivr.net/npm/docsify@5"></script>
|
|
</body>
|
|
</html>
|
|
```
|
|
|
|
### Specifying docsify versions
|
|
|
|
?> Note that in both of the examples below, docsify URLs will need to be manually updated when a new major version of docsify is released (e.g. `v5.x.x` => `v6.x.x`). Check the docsify website periodically to see if a new major version has been released.
|
|
|
|
Specifying a major version in the URL (`@5`) will allow your site to receive non-breaking enhancements (i.e. "minor" updates) and bug fixes (i.e. "patch" updates) automatically. This is the recommended way to load docsify resources.
|
|
|
|
<!-- prettier-ignore -->
|
|
```html
|
|
<!-- Theme -->
|
|
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@5/themes/vue.min.css" />
|
|
|
|
<!-- Docsify -->
|
|
<script src="//cdn.jsdelivr.net/npm/docsify@5"></script>
|
|
```
|
|
|
|
If you prefer to lock docsify to a specific version, specify the full version after the `@` symbol in the URL. This is the safest way to ensure your site will look and behave the same way regardless of any changes made to future versions of docsify.
|
|
|
|
<!-- prettier-ignore -->
|
|
```html
|
|
<!-- Theme -->
|
|
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@5/themes/vue.min.css" />
|
|
|
|
<!-- Docsify -->
|
|
<script src="//cdn.jsdelivr.net/npm/docsify@5"></script>
|
|
```
|
|
|
|
### Manually preview your site
|
|
|
|
If you have Python installed on your system, you can easily use it to run a static server to preview your site.
|
|
|
|
```python
|
|
# Python 2
|
|
cd docs && python -m SimpleHTTPServer 3000
|
|
```
|
|
|
|
```python
|
|
# Python 3
|
|
cd docs && python -m http.server 3000
|
|
```
|
|
|
|
## Loading dialog
|
|
|
|
If you want, you can show a loading dialog before docsify starts to render your documentation:
|
|
|
|
```html
|
|
<!-- index.html -->
|
|
|
|
<div id="app">Please wait...</div>
|
|
```
|
|
|
|
You should set the `data-app` attribute if you changed `el`:
|
|
|
|
```html
|
|
<!-- index.html -->
|
|
|
|
<div data-app id="main">Please wait...</div>
|
|
|
|
<script>
|
|
window.$docsify = {
|
|
el: '#main',
|
|
};
|
|
</script>
|
|
```
|
|
|
|
Compare [el configuration](configuration.md#el).
|