Skip to content

Commit dd26d35

Browse files
docs: Update README.md
1 parent 7ac1a23 commit dd26d35

File tree

1 file changed

+9
-23
lines changed

1 file changed

+9
-23
lines changed

Diff for: docs/README.md

+9-23
Original file line numberDiff line numberDiff line change
@@ -63,43 +63,29 @@ Apply these rules to the latter part of markdown URLs such as `[Text](page.md)`.
6363

6464
## Serve a _Docsify_ site locally
6565

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.
6767

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.
7569
```bash
7670
$ # From project root.
7771
$ docsify serve docs
7872
$ # Shortcut.
7973
$ make docs
8074
```
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.
9276
```bash
93-
$ pserve
77+
$ cd docs
78+
$ python3 -m http.server 3000
9479
```
80+
- Choose something else from this big list - [link](https://gist.github.com/willurd/5720255).
9581

9682
## Quickstart local server
9783

9884
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.
9985

10086
### 1. Install
10187

102-
Clone this repo to your machine.
88+
Clone this repo to your machine with one of these commands:
10389

10490
```bash
10591
$ # Clone with SSH
@@ -122,7 +108,7 @@ Follow [Serve a Docsify site locally](#serve-a-docsify-site-locally) instruction
122108

123109
#### 2.2 View
124110

125-
Then open http://localhost:3000 in the browser.
111+
Open http://localhost:3000 in the browser.
126112

127113
User notes:
128114

@@ -137,7 +123,7 @@ Follow to steps in this section copy a base structure and configs from this proj
137123

138124
### 1. Get this project locally
139125

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.
141127

142128
```bash
143129
$ # Clone with SSH

0 commit comments

Comments
 (0)