Skip to content

Commit d5b4326

Browse files
committed
docs: Update README.md files
1 parent 5ecc114 commit d5b4326

File tree

2 files changed

+13
-7
lines changed

2 files changed

+13
-7
lines changed

README.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
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/)
6-
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/MichaelCurrin/docsify-js-tutorial/blob/master/LICENSE)
6+
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](#license)
77

8-
Links:
8+
**Links:**
99

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.
10+
- [Docsify JS Tutorial](https://michaelcurrin.github.io/docsify-js-tutorial/#/) site - docs for this repo.
11+
- [Docsify JS Template](https://github.com/MichaelCurrin/docsify-js-template) repo - a separate repo which accompanies this tutorial and can be reused easily through _Use this template_ button.
1212

1313
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.
1414

@@ -49,3 +49,9 @@ See also the [Nested Example](/nested_example/README.md) section for understandi
4949
## Contributing
5050

5151
The repo is open for accepting contributions through a Pull Request.
52+
53+
## License
54+
55+
[MIT license](https://github.com/MichaelCurrin/docsify-js-tutorial/blob/master/LICENSE)
56+
57+
Modify and reuse this project. Please link back to this repo.

docs/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Docsify JS Tutorial
2-
> How to build a docs site with _Docsify-JS_ and Github Pages
2+
> How to build a docs site using _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/)
6-
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/MichaelCurrin/docsify-js-tutorial/blob/master/LICENSE)
6+
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/MichaelCurrin/docsify-js-tutorial/blob/master/README.md#license)
77

88
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_.
99

@@ -40,7 +40,7 @@ Once you have that setup in _docs_ directory and have pushed to Github, you can
4040

4141
### Linking to pages
4242

43-
Instructions for creating valid Docsify links in your markdown files.
43+
Instructions for creating valid _Docsify_ links in your markdown files.
4444

4545
The _Docsify_ site is served from the `docs` directory with restrictions on links between files. Therefore you must ensure your markdown files (including the [sidebar](#sidebar)) are valid.
4646

0 commit comments

Comments
 (0)