jyapayne/docsify
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update english docs

Browse source
This commit is contained in:
Johannes Rappen 2017-03-09 22:19:07 +01:00
commit 6eada5a2f7
19 changed files with 159 additions and 129 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/quickstart.md
View file

@ -8,7 +8,7 @@ npm i docsify-cli -g
## Initialize
If you want to write the documentation in the `./docs` directory, you can use the `init` command.
If you want to write the documentation in the `./docs` subdirectory, you can use the `init` command.
```bash
docsify init ./docs
@ -16,20 +16,18 @@ docsify init ./docs
## Writing content
After the init is complete, you can see the file list in the docs directory.
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
- `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).
You can easily update the documentation in `./docs/README.md`, of course you can add [more pages](more-pages).
## 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
```
@ -38,7 +36,7 @@ docsify serve docs
## Manual initialization
If you don't like npm or have trouble installing the tool, you can manually create `index.html`:
If you don't like `npm` or have trouble installing the tool, you can manually create `index.html`:
```html
<!-- index.html -->
@ -52,7 +50,7 @@ If you don't like npm or have trouble installing the tool, you can manually crea
<body>
<div id="app"></div>
</body>
<script src="//unpkg.com/docsify"></script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
</html>
```
@ -85,3 +83,5 @@ You should set the `data-app` attribute if you changed `el`:
}
</script>
```
Compare [el configuration](/configuration#el).