Skip to content

Commit f29a9a4

Browse files
docs: Update tutorial
1 parent 4648cc7 commit f29a9a4

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

docs/README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
# Docsify Template
22
> How to build a docs site with _Docsify-JS_ and Github Pages
33
4-
Convert your docs folder into a pretty docs website using [Docsify-JS](https://docsify.js.org/) and some minimal setup instructions. This Docsify Template site is running on _Docsify_.
4+
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_.
55

6-
My own aim is to turn the docs of many of my existing projects into doc sites, with minimal effort to convert them and then maintain them and their dependencies.
6+
Two main sections of this project:
7+
8+
- [Quickstart local server](#quickstart-local-server) - Get a demo site running.
9+
- [Setup your own docs site](#setup-your-own-docs-site) - Convert your docs directory into a docs site hosted on Github pages. Uses templates files to get up and running with as little effort as possible.
710

811
_Note: The instructions in this repo are intended for Linux and Mac environments._
912

@@ -78,7 +81,6 @@ alias docs='docsify serve docs'
7881

7982
Then open http://localhost:3000 in the browser.
8083

81-
8284
User notes:
8385

8486
- When viewing the site, if you scroll down far enough you will see a hamburger menu which lets you dynamically open or close the sidebar.
@@ -92,15 +94,14 @@ Follow to steps in this section copy a base structure and configs from this proj
9294

9395
### 1. Get this project locally
9496

95-
Clone this repo to your machine using the [steps](#get-a-local-copy-of-this-repo) above.
97+
Clone _this_ template repo to your machine using the [steps](#get-a-local-copy-of-this-repo) above.
9698

9799
### 2. Create base structure
98100

99-
Navigate to your project's docs directory.
101+
Navigate to _your_ project's `docs` directory.
100102
101103
```bash
102-
$ cd <PATH_TO_YOUR_REPO>
103-
$ cd docs
104+
$ cd <PATH_TO_YOUR_REPO>/docs
104105
```
105106
106107
Create a file for Github Pages use. This can remain empty - its existence just tells Github Pages to include the underscore files in builds.

0 commit comments

Comments
 (0)