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
+5-6Lines changed: 5 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -128,10 +128,8 @@ Clone this template repo to your machine using the [steps](#get-a-local-copy-of-
128
128
```bash
129
129
$ cp <PATH_TO_TEMPLATE_REPO>/quickstart/. .
130
130
```
131
-
132
-
Note that you do not need a page for`404 - Not found` as Docsify renders one for you.
133
-
134
-
Your existing markdown files in your `docs` directory can now be served as a doc site. You may run a [serve](#21-serve) command now. Then, as you follow the customization steps below, you can check the frontend for incremental changes for areas like styling and fixing links.
131
+
3. View the contents of the docs directory to see what was added. Note that you do not need an error page _Docsify_ provides a `404 - Not found` page on a bad URL.
132
+
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.
135
133
136
134
137
135
### 3. Configure homepage
@@ -178,7 +176,7 @@ Guidelines for setting up a sidebar file:
178
176
To setup a custom sidebar:
179
177
180
178
1. Edit the *_sidebar.md* file.
181
-
2. Add items. Example:
179
+
2. Add items using guide above. Example:
182
180
```markdown
183
181
- [Home](#docsify-template)
184
182
- [Foo](foo.md)
@@ -188,6 +186,7 @@ To setup a custom sidebar:
188
186
* [Foo Bar](baz/foobar.md)
189
187
```
190
188
189
+
191
190
#### Note on homepage link
192
191
193
192
The clickable text above the standard sidebar takes you to the cover page. You can scroll down to the homepage (_docs/README.md_), but there are no links on the page to the homepage. Therefore a link to the homepage has been included in the example above.
@@ -240,7 +239,7 @@ Find the style which is set in the `<head>` tag, which looks like this.
0 commit comments