Skip to content

Commit 743f857

Browse files
committed
docs: Update README.md
1 parent c56733f commit 743f857

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
1-
# Docsify Template
2-
> Tutorial on how to build a docs site with _Docsify-JS_ and _Github Pages_, including an easy quickstart template
1+
# Docsify JS Tutorial
2+
> Tutorial on how to build a docs site with _Docsify-JS_ and _Github Pages_
33
44
[![Made with latest Docsify](https://img.shields.io/npm/v/docsify?label=docsify)](https://docsify.js.org/)
55
[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/docsify-js-tutorial.svg)](https://GitHub.com/MichaelCurrin/docsify-js-tutorial/tags/)
66
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/MichaelCurrin/docsify-js-tutorial/blob/master/LICENSE)
77

8-
Docs site:
8+
Links:
99

10-
- https://michaelcurrin.github.io/docsify-js-tutorial/#/
10+
- [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.
1112

1213
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.
1314

1415

16+
<!-- TODO move content to docs -->
17+
1518
## 🎯 Project aims
1619

17-
The idea is to:
20+
My aims for building a docs site are:
1821

1922
- add as little code and configuration as possible
2023
- make it easy to maintain
@@ -38,7 +41,7 @@ The tutorial is available in two forms:
3841
- 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.
3942
- Project docs: View the docs as plain markdown format in the repo, either locally or on Github. See the [docs](/docs) directory.
4043

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.
4245

4346
See also the [Nested Example](/nested_example/README.md) section for understanding links in markdown and the sidebar.
4447

0 commit comments

Comments
 (0)