Skip to content

Commit b06f773

Browse files
docs: Update homepage
1 parent 45731a6 commit b06f773

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

docs/README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -413,10 +413,14 @@ _Docsify_ also provides a convenient but optional CLI. It helps you create and s
413413
414414
### Setup
415415
416-
Links:
416+
```bash
417+
$ npm i docsify-cli -g
418+
```
417419
418-
- [Docsify Quickstart](https://docsify.js.org/#/quickstart) guide - how to install the CLI in your global node packages and then use it.
419-
- [CLI documentation](https://docsifyjs.github.io/docsify-cli).
420+
Links for installing and using the CLI.
421+
422+
- [Docsify Quickstart](https://docsify.js.org/#/quickstart) on _Docsify_ homepage.
423+
- [Docsify CLI](https://docsifyjs.github.io/docsify-cli) project's docs.
420424
421425
### Commands
422426
@@ -436,19 +440,21 @@ $ docsify init docs
436440
437441
> Run local server to preview site.
438442
439-
Serve the target directory as docs site locally, with hot reload for if you save any file changes. See [server](#21-serve) options above.
443+
Serve the target directory as a docs site locally. This includes hot reload, to refresh the page on file changes. See [serve](#21-serve) options above.
440444
441445
e.g.
442446
443447
```bash
444448
$ docsify serve docs
445449
```
446450
451+
Serves as [localhost:3000/](http://localhost:3000/), or a different port if there is already a _Docsify_ server running.
452+
447453
#### start
448454
449455
> Server for SSR
450456
451-
For Server-Side Rendering. I haven't tried this yet.
457+
This command is for Server-Side Rendering. I haven't tried this yet.
452458
453459
## Static site vs SPA
454460

0 commit comments

Comments
 (0)