Skip to content

Commit e2d59dc

Browse files
committed
docs: Update docs/README.md
1 parent b7c27fd commit e2d59dc

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

docs/README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,13 @@ _Note: The instructions in this repo for for Linux and Mac environments._
1919

2020
Note that this works _without_ editing your existing docs and _without_ building any HTML pages. The rendering is done on the client-side in a single page application, running on _index.html_.
2121

22-
2322
## Quickstart
2423

2524
### Setup
2625

27-
No installation needed. Just a connection to the internet in order to load the _Docsify_ library in the browser.
26+
No installation is needed.
27+
28+
You need connection to the internet in order to load the _Docsify_ library in the browser.
2829

2930
### Run locally
3031

@@ -34,7 +35,13 @@ $ git clone [email protected]:MichaelCurrin/docsify-template.git
3435
$ # Clone with HTTPS
3536
$ git clone https://github.com/MichaelCurrin/docsify-template.git
3637
$ cd docsify-template
37-
$ ./serve.sh
38+
```
39+
40+
Choose whatever approach you wish to serve the docs folder. There are many listed [here](https://gist.github.com/willurd/5720255). Here are a some examples:
41+
42+
```bash
43+
$ python3 -m http.server 3000
44+
$ docsify serve docs
3845
```
3946

4047
Then open http://localhost:3000 in the browser.
@@ -43,6 +50,7 @@ User notes:
4350

4451
- When viewing the site, if you scroll down far enough you will see a hamburger menu which lets you dynamically open or close the sidebar.
4552

53+
4654
## Setup your own docs site
4755

4856
The idea is to add to an existing project / git repo, so it is not that useful to create your own project from this repo. So rather copy base structure and configs from this project to your own, then customize them for your needs.
@@ -143,10 +151,12 @@ More on Docsify [themes](https://docsify.js.org/#/themes?id=themes) guide.
143151

144152
## Docsify CLI
145153

146-
The CLI tool is optional. View the Docsify [Quickstart](https://docsify.js.org/#/quickstart) guide to set up the CLI tool and see how to do the following:
154+
The CLI tool is optional. It can be used to do the following.
147155

148156
- `init`: Setup an initial _README.md_ (duplicated from project root), _index.html_ and _.nojekyll_ in your a target directory such as _docs_. You can do this by hand or using a template if you don't want the CLI to do it for you.
149-
- `serve`: Serve the docs site locally, with hot reload.
157+
- `serve`: Serve the docs site locally, with hot reload. For convenience, you can run `./serve.sh` in his project's root to save a few keystrokes when you want to start the server.
158+
159+
View the Docsify [Quickstart](https://docsify.js.org/#/quickstart) guide for how to install the CLI in your global node packages and then to use it.
150160

151161

152162
## Why not a static site generator?

0 commit comments

Comments
 (0)