Skip to content

Commit 4b0b4f5

Browse files
docs: Update README.md
1 parent 8caf8b0 commit 4b0b4f5

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Docsify Template
22
> Skeleton of a light docs site built on _Docsify-JS_ and running on Github Pages
33
4+
This project provides instructions on how to turn the docs directory of your project into a docs site hosted on Github Pages, using this site's configs and structure as a starting point.
45

5-
## Documentation
66

7-
The other docs contain more detailed instructions on how to create your own docs site using this project's skeleton structure and basic configs.
7+
## Documentation
88

9-
- Online docs: [Github Page site](https://michaelcurrin.github.io/docsify-template/#/).
10-
- Local docs: Start with the [readme](/docs/README.md) in the [docs](/docs) directory.
9+
- Online docs: [Github Page site](https://michaelcurrin.github.io/docsify-template/#/). This is both a tutorial as well a live demo of the kind of site you would have after following the tutorial.
10+
- Project docs: Start at the [readme](/docs/README.md) in the [docs](/docs) directory. These docs lack _Docsify_ styling but contain the same content as they are used in serving the online docs site.
1111

1212

1313
## License

0 commit comments

Comments
 (0)