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
This project will guide you on how to convert your project's docs folder into a pretty and elegant docs website. This project's own docs site is built on _Docsify-JS_ so serves as a good example.
13
13
@@ -17,7 +17,7 @@ This project will guide you on how to convert your project's docs folder into a
17
17
The idea is to:
18
18
19
19
- add as little code and configuration as possible
20
-
- make it easy to maintain
20
+
- make it easy to maintain
21
21
- quick to get setup on existing projects
22
22
- have no layout files
23
23
- reduce dependencies
@@ -35,7 +35,7 @@ _Docsify_ works as a single-page application on this one page - data from your m
35
35
36
36
The tutorial is available in two forms:
37
37
38
-
- Github Pages: [docs site](https://michaelcurrin.github.io/docsify-template/#/). This also live demo of the kind of site you would have after completing the tutorial.
38
+
- Github Pages: [docs site](https://michaelcurrin.github.io/docsify-js-tutorial/#/). This also live demo of the kind of site you would have after completing the tutorial.
39
39
- Project docs: View the docs as plain markdown format in the repo, either locally or on Github. See the [docs](/docs) directory.
40
40
41
41
The tutorial references the [quickstart](/quickstart) directory at the project root, in case you want to see that.
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_.
9
9
@@ -89,13 +89,13 @@ Clone this repo to your machine with one of these commands:
1. Ensure `loadSidebar: true` is set in the _index.html_ file.
198
198
- The value of `true` means `*_sidebar.md*` will be referenced by the app.
199
-
- The sidebar is already enabled in the quickstart [index.html](https://github.com/MichaelCurrin/docsify-template/blob/master/quickstart/index.html).
199
+
- The sidebar is already enabled in the quickstart [index.html](https://github.com/MichaelCurrin/docsify-js-tutorial/blob/master/quickstart/index.html).
200
200
2. Edit the *_sidebar.md* file.
201
201
3. Add items using the guidelines above.
202
202
@@ -218,7 +218,7 @@ This is really the text of heading element, which has been made lowercase and hy
218
218
219
219
The cover page is the first page that a visitor sees before scrolling down to the homepage.
220
220
221
-
If you want to use it, edit your *docs/_coverpage.md* file and complete the `TODO` items. You can also use this project's [cover page](https://raw.githubusercontent.com/MichaelCurrin/docsify-template/master/docs/_coverpage.md) on Github as a reference.
221
+
If you want to use it, edit your *docs/_coverpage.md* file and complete the `TODO` items. You can also use this project's [cover page](https://raw.githubusercontent.com/MichaelCurrin/docsify-js-tutorial/master/docs/_coverpage.md) on Github as a reference.
222
222
223
223
You can add additional buttons to the bottom of the homepage, but there should be no gaps between the lines in your file. And the last one will be solid while the others will be transparent.
0 commit comments