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
Convert your docs folder into a pretty docs website using [Docsify-JS](https://docsify.js.org/) and some minimal setup instructions. This project's doc site itself running on _Docsify_.
5
8
6
9
This project aims to use easy instructions for newcomers to Docsify and also includes as little effort as possible to get the quickstart / template project copied into your own project.
Convert your docs folder into a pretty docs website using [Docsify-JS](https://docsify.js.org/) and some minimal setup instructions. This project's doc site itself is also running on _Docsify_.
5
8
6
9
Two main sections of this project:
@@ -188,7 +191,7 @@ Example:
188
191
189
192
1. Ensure `loadSidebar: true` is set in the _index.html_ file.
190
193
- The value of `true` means `*_sidebar.md*` will be referenced by the app.
191
-
- The sidebar is already enabled in the quicksart [index.html](https://github.com/MichaelCurrin/docsify-template/blob/master/quickstart/index.html).
194
+
- The sidebar is already enabled in the quickstart [index.html](https://github.com/MichaelCurrin/docsify-template/blob/master/quickstart/index.html).
192
195
2. Edit the *_sidebar.md* file.
193
196
3. Add items using the guidelines above.
194
197
@@ -201,7 +204,7 @@ The clickable text above the standard sidebar takes you to the cover page. You c
201
204
- [Home](/#my-app)
202
205
```
203
206
204
-
NB. The leading forwardslash is **required** here for correct behavior. As the anchor tag will be invalid on other pages such as `foo.md` which has path `/#/foo/`).
207
+
NB. The leading forward slash is **required** here for correct behavior. As the anchor tag will be invalid on other pages such as `foo.md` which has path `/#/foo/`).
205
208
206
209
The link is a reference to an anchor tag on the root URL, where anchor tag refers the ID of the homepage heading element. This ID will be created by _Docsify_. To find it, go to the coverpage, scroll down to the homepage and click on the heading. The URL will be something like `http://localhost:3000/#/?id=my-app`. The part we want is the end e.g. `my-app`.
207
210
@@ -260,7 +263,7 @@ Replace the end of URL with one of these four themes:
260
263
261
264
You can optionally remove `/lib` from the theme URL to get the _uncompressed_ CSS file.
262
265
263
-
More on Docsify [themes](https://docsify.js.org/#/themes?id=themes) guide.
266
+
Read more on the _Docsify_ [themes](https://docsify.js.org/#/themes?id=themes) guide.
0 commit comments