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
-[Docsify JS Tutorial](https://michaelcurrin.github.io/docsify-js-tutorial/#/) docs site for this repo.
11
+
-[Docsify JS Template](https://github.com/MichaelCurrin/docsify-js-template) - a separate repo which accompanies this tutorial and can be reused easily through _Use this template_ button.
11
12
12
13
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
14
14
15
16
+
<!-- TODO move content to docs -->
17
+
15
18
## 🎯 Project aims
16
19
17
-
The idea is to:
20
+
My aims for building a docs site are:
18
21
19
22
- add as little code and configuration as possible
20
23
- make it easy to maintain
@@ -38,7 +41,7 @@ The tutorial is available in two forms:
38
41
- 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
42
- Project docs: View the docs as plain markdown format in the repo, either locally or on Github. See the [docs](/docs) directory.
40
43
41
-
The tutorial references the `docs` directory of my [Docsify JS Template](https://github.com/MichaelCurrin/docsify-js-template if you want to jump that.
44
+
The tutorial references the `docs` directory of my [Docsify JS Template](https://github.com/MichaelCurrin/docsify-js-template) if you want to jump that.
42
45
43
46
See also the [Nested Example](/nested_example/README.md) section for understanding links in markdown and the sidebar.
0 commit comments