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
Copy file name to clipboardExpand all lines: docs/README.md
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,12 @@
1
1
# Docsify Template
2
2
> How to build a docs site with _Docsify-JS_ and Github Pages
3
3
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_.
5
5
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.
7
10
8
11
_Note: The instructions in this repo are intended for Linux and Mac environments._
9
12
@@ -78,7 +81,6 @@ alias docs='docsify serve docs'
78
81
79
82
Then open http://localhost:3000 in the browser.
80
83
81
-
82
84
User notes:
83
85
84
86
- 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
92
94
93
95
### 1. Get this project locally
94
96
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.
96
98
97
99
### 2. Create base structure
98
100
99
-
Navigate to your project's docs directory.
101
+
Navigate to _your_ project's `docs` directory.
100
102
101
103
```bash
102
-
$ cd <PATH_TO_YOUR_REPO>
103
-
$ cd docs
104
+
$ cd <PATH_TO_YOUR_REPO>/docs
104
105
```
105
106
106
107
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