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
+13-11Lines changed: 13 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,11 @@
1
1
# Docsify Template
2
2
> Live demo of a light docs site built on _Docsify-JS_ and running on Github Pages
3
3
4
-
Convert your docs folder into a pretty docs website using _docsify_ and some minimal setup. This project can be used as a template or reference for your own.
See the [Docsify](https://docsify.js.org/)website.
6
+
Convert your docs folder into a pretty docs website using [Docsify-JS](https://docsify.js.org/)and some minimal setup. This project can be used as a template or reference for your own.
7
7
8
8
9
-
## How it works
10
-
11
-
Note that this works without editing your existing docs and without building any HTML page.
12
-
13
-
If you were using a static site generator like Jekyll, you might have to add front matter to your docs, in addition to setting Jekyll config for theme and menu layout.
14
-
15
-
Also, with a static site generator you would build HTML files to serve, while with docsify there is a single page application running off of a _index.html_ - on each request, a markdown file is fetched by the client and rendered as HTML with a theme and menu.
16
-
17
9
## Setup
18
10
19
11
### Overview steps
@@ -22,7 +14,10 @@ Also, with a static site generator you would build HTML files to serve, while wi
22
14
-**index page** - Homepage of the your docs site. This will setup the app using the _docsify_ library, set a theme and apply other configurations.
23
15
-**sidebar** - Describes your menu layout. As _docsify_ is not aware of directory structure so it may not function as you hope without this file.
24
16
-**cover page** - Optional landing page with background image and minimal text.
25
-
2. Turn your Github repo into a Github pages site which builds from the docs directory.
17
+
2. Update your Github repo's config so that you will get a Github Pages site built from your docs directory. _Docsify_ also works with _Netlify_ as per their docs, but this project just considers the Github Pages case.
18
+
19
+
Note that this works _without_ editing your existing docs and _without_ building any HTML pages. The rendering is done on the client-side in a single page application, running on _index.html_.
20
+
26
21
27
22
## Setup a site
28
23
@@ -72,3 +67,10 @@ View the Docsify [Quickstart](https://docsify.js.org/#/quickstart) guide for ins
72
67
The CLI tool is optional and is useful for the following:
73
68
- Setup an initial _README.md_ (duplicated from project root), _index.html_ and _.nojekyll_ in your a target directory such as _docs_. You can do this by hand or using a template if you don't want the CLI to do it for you.
74
69
- Serve the docs site locally, with hot reload.
70
+
71
+
72
+
## Why not a static site generator?
73
+
74
+
If you were using a static site generator like Jekyll, you might have to add front matter to your docs, in addition to setting Jekyll config for theme and menu layout.
75
+
76
+
Also, with a static site generator you would build HTML files to serve, while with docsify there is a single page application running off of a _index.html_ - on each request, a markdown file is fetched by the client and rendered as HTML with a theme and menu.
0 commit comments