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
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_.
8
+
Convert your _docs_ folder into a pretty docs website using [Docsify-JS](https://docsify.js.org/) and some minimal setup instructions. This project's site itself is also running on _Docsify_.
9
9
10
-
If you know what _Docsify_ is and want to start using it immediately, feel free to skip to one of these sections:
10
+
## Start a Docsify site
11
11
12
-
-[Quickstart local server](#quickstart-local-server) - Get a demo site running.
13
-
-[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.
12
+
This project provides three options for a choosing a docs site to run:
13
+
14
+
-[Quickstart local server](#quickstart-local-server)
15
+
- Clone this repo and start serving the docs repo.
16
+
-[Setup your own docs site](#setup-your-own-docs-site)
17
+
- Convert your _docs_ directory into a docs site hosted on Github Pages. Copy from some templates files to get up and running with as little effort as possible.
- A minimal template which was moved out of this project into a separate repo.
20
+
- Click _Use this template_ there and you'll be able to starting serving a site on Github Pages or locally.
14
21
15
22
_Note: The instructions in this repo are intended for Linux and macOS environments._
16
23
17
24
## Why use _Docsify_?
18
25
19
-
My requirement is to build a docs site with minimal setup to use existing docs directories without restructuring or formatting the docs. I found _Docsify_ is ideal for this.
26
+
My requirement was to build a docs site with minimal setup to use existing docs directories without restructuring or formatting the docs. I found _Docsify_ is ideal for this.
20
27
21
28
You can use _Docsify_ with its defaults or very simple tweaks, yet get a UI with menus, themes, mobile functionality and a cover page. And page loads are seamless in the shell as it is a SPA. These things that take more effort and code changes or additions if you want to do them with static-site generators. _Docsify_ also documentation as its main purpose, unlike some other tools.
22
29
@@ -28,7 +35,7 @@ A _Docsify_ doc site works works _without_ the need to edit your existing docs a
28
35
29
36
### Structure
30
37
31
-
Main components of a _Docsify_ site.
38
+
Main components of a _Docsify_ site:
32
39
33
40
-**cover page** - Optional. Landing page with background color or image and some minimal text.
34
41
-**homepage** - First page that a user sees, after the cover page. This is a content page written in markdown and it could be the only page of your site if you like.
@@ -67,17 +74,17 @@ Start running a local server to preview a _Docsify_ site. Choose an option below
67
74
68
75
- Run [Docsify CLI](#docsify-cli) web server.
69
76
```bash
70
-
$ # From project root.
77
+
$ # From project root, serve docs directory.
71
78
$ docsify serve docs
72
-
$ # Shortcut.
79
+
$ # Shortcut provided by Makefile.
73
80
$ make docs
74
81
```
75
82
- Run a Python web server.
76
83
```bash
77
84
$ cd docs
78
85
$ python3 -m http.server 3000
79
86
```
80
-
- Choose something elsefrom this big list - [link](https://gist.github.com/willurd/5720255).
87
+
- Choose another server option from this large list - [link](https://gist.github.com/willurd/5720255).
0 commit comments