You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/README.md
+9-23
Original file line number
Diff line number
Diff line change
@@ -63,43 +63,29 @@ Apply these rules to the latter part of markdown URLs such as `[Text](page.md)`.
63
63
64
64
## Serve a _Docsify_ site locally
65
65
66
-
Start running a local server to preview a _Docsify_ site. Choose an option below.
66
+
Start running a local server to preview a _Docsify_ site. Choose an option below depending on whether you want to install and run Docsify locally or use something you already have installed.
67
67
68
-
- Run Python web server.
69
-
```bash
70
-
$ cd docs
71
-
$ python3 -m http.server 3000
72
-
$ python2 -m SimpleHTTPServer 3000
73
-
```
74
-
- Run [Docsify CLI](#docsify-cli) web server. This must be installed locally.
68
+
- Run [Docsify CLI](#docsify-cli) web server.
75
69
```bash
76
70
$ # From project root.
77
71
$ docsify serve docs
78
72
$ # Shortcut.
79
73
$ make docs
80
74
```
81
-
- Run using something else. Choose from this list - [link](https://gist.github.com/willurd/5720255).
82
-
83
-
**Aliases**
84
-
85
-
Pro-tip! You can also add aliases to either your `~/.bashrc` or `~/.aliases` files to make them quick to use across projects.
86
-
87
-
- Setup
88
-
```bash
89
-
$ alias pserve='python3 -m http.server 3000'
90
-
```
91
-
- Run
75
+
- Run a Python web server.
92
76
```bash
93
-
$ pserve
77
+
$ cd docs
78
+
$ python3 -m http.server 3000
94
79
```
80
+
- Choose something else from this big list - [link](https://gist.github.com/willurd/5720255).
95
81
96
82
## Quickstart local server
97
83
98
84
Follow these steps to setup and run an existing _Docsify_ project locally . In this case, we get a local copy of this _Docsify Template_ project and serve it.
99
85
100
86
### 1. Install
101
87
102
-
Clone this repo to your machine.
88
+
Clone this repo to your machine with one of these commands:
103
89
104
90
```bash
105
91
$ # Clone with SSH
@@ -122,7 +108,7 @@ Follow [Serve a Docsify site locally](#serve-a-docsify-site-locally) instruction
122
108
123
109
#### 2.2 View
124
110
125
-
Then open http://localhost:3000 in the browser.
111
+
Open http://localhost:3000 in the browser.
126
112
127
113
User notes:
128
114
@@ -137,7 +123,7 @@ Follow to steps in this section copy a base structure and configs from this proj
137
123
138
124
### 1. Get this project locally
139
125
140
-
Clone this template repo to your machine using the steps below, so you can use it copy files from later.
126
+
Clone this template repo to your machine using one of the steps below, so you can use it copy files from later.
0 commit comments