Skip to content

Commit 70b569a

Browse files
committed
docs: Update homepage
1 parent 75da464 commit 70b569a

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

docs/README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -128,10 +128,8 @@ Clone this template repo to your machine using the [steps](#get-a-local-copy-of-
128128
```bash
129129
$ cp <PATH_TO_TEMPLATE_REPO>/quickstart/. .
130130
```
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.
135133

136134

137135
### 3. Configure homepage
@@ -178,7 +176,7 @@ Guidelines for setting up a sidebar file:
178176
To setup a custom sidebar:
179177

180178
1. Edit the *_sidebar.md* file.
181-
2. Add items. Example:
179+
2. Add items using guide above. Example:
182180
```markdown
183181
- [Home](#docsify-template)
184182
- [Foo](foo.md)
@@ -188,6 +186,7 @@ To setup a custom sidebar:
188186
* [Foo Bar](baz/foobar.md)
189187
```
190188
189+
191190
#### Note on homepage link
192191
193192
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.
240239
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/<THEME>">
241240
```
242241
243-
Replace the end of URL with one of these four themes.
242+
Replace the end of URL with one of these four themes:
244243
245244
- `vue.css`
246245
- `buble.css`

0 commit comments

Comments
 (0)