Skip to content

Commit 8c63449

Browse files
committed
docs: Update docs/README.md
1 parent 2087dc3 commit 8c63449

File tree

1 file changed

+22
-24
lines changed

1 file changed

+22
-24
lines changed

Diff for: docs/README.md

+22-24
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,9 @@ Follow [Serve a Docsify site locally](#serve-a-docsify-site-locally) instruction
117117

118118
#### 2.2 View
119119

120-
Open http://localhost:3000 in the browser.
120+
Open in the browser.
121+
122+
- http://localhost:3000
121123

122124
User notes:
123125

@@ -126,40 +128,36 @@ User notes:
126128

127129
## Setup your own docs site
128130

129-
This tutorial is based on the _Docsify_ [Quickstart](https://docsify.js.org/#/quickstart) guide, but rather than giving snippets of file this tutorial lets you copy entire template files to your project, there are `TODO` items in the templates making it clear what to edit. Plus in the template, there are some useful or pretty configurations which have been set after investigating the configurations guide and trying them out on my own project.
131+
This tutorial is based on the _Docsify_ [Quickstart](https://docsify.js.org/#/quickstart) guide, but rather than giving snippets of file this tutorial lets you copy entire template files to your project, there are `TODO` items in the templates making it clear what to edit.
132+
133+
Plus, in the template, there are some useful or pretty configurations which have been set after investigating the configurations guide and trying them out on my own project.
130134

131135
Follow to steps in this section copy a base structure and configs from this project to your own, then customize them for your needs.
132136

133-
### 1. Get this project locally
137+
### 1. Create base structure
134138

135-
Clone this template repo to your machine using one of the steps below, so you can use it copy files from later.
136139

137-
```bash
138-
$ # Clone with SSH
139-
$ git clone [email protected]:MichaelCurrin/docsify-js-tutorial.git
140-
$ # Clone with HTTPS
141-
$ git clone https://github.com/MichaelCurrin/docsify-js-tutorial.git
140+
Navigate to your own project's _docs_ directory on the command-line.
141+
142+
```sh
143+
$ cd my-project/docs
142144
```
143145
144-
```bash
145-
$ cd docsify-js-tutorial
146+
The repo has an accompanying [Docsify JS Template](https://github.com/MichaelCurrin/docsify-js-template) repo. Copy the base files from there into your own project. Note this will **overwrite** any existing files.
147+
148+
```sh
149+
146150
```
147151
148-
### 2. Create base structure
149152
150-
1. Navigate to your existing project's `docs` directory.
151-
```bash
152-
$ cd <PATH_TO_YOUR_REPO>/docs
153-
```
154-
2. Copy the copy the contents of the template project's _quickstart_ directory to your own project. Note the trailing dot on the first path in order to include hidden files.
155-
```bash
156-
$ cp <PATH_TO_TEMPLATE_REPO>/quickstart/. .
157-
```
158-
3. View the contents of the docs directory to see what was added. Note that _Docsify_ provides a `404 - Not found` page for a bad URL so you do not need to.
159-
4. To see what the base site look like, start a server now using a command from the [serve](#21-serve) section. Open the web page URL and keep it open so you can check on it as you make changes in the following sections. If you use the _Docsify_ server, the page will auto refresh on a file save, otherwise you will have to manually refresh.
153+
154+
Now View the contents of the docs directory to see what was added.
155+
Note that _Docsify_ provides a `404 - Not found` page for a bad URL so you do not need to create a 404 page yourself.
156+
157+
To see what the base site look like, start a server now using a command from the [serve](#21-serve) section. Open the web page URL and keep it open so you can check on it as you make changes in the following sections. If you use the _Docsify_ server, the page will auto refresh on a file save, otherwise you will have to manually refresh.
160158
161159
162-
### 3. Configure homepage
160+
### 2. Configure homepage
163161
164162
Edit your homepage (_docs/README.md_). Complete the `TODO` items, using the suggestions in this section.
165163
@@ -168,7 +166,7 @@ Edit your homepage (_docs/README.md_). Complete the `TODO` items, using the sugg
168166
- Note that you are not required to put in links to other docs file within your homepage file. As that is what the _Docsify_ sidebar. If you do put in any links in your homepage, they must be relative to the _docs_ directory, such as `file.md`. See [Doc links](#doc-links) for more info.
169167
170168
171-
### 4. Configure menu structure
169+
### 3. Configure menu structure
172170
173171
#### Auto sidebar
174172

0 commit comments

Comments
 (0)