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
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,13 +4,13 @@
4
4
5
5
## What is it
6
6
7
-
docsify generates your documentation website on the fly. Unlike GitBook, it does not generate static html files. It smartly loads and parses your Markdown files and displays them in website. All you need to do is create an `index.html` to start and [deploy it on GitHub Pages](/deploy).
7
+
docsify generates your documentation website on the fly. Unlike GitBook, it does not generate static html files. Instead, it smartly loads and parses your Markdown files and displays them as website. All you need to do is create an `index.html` to start and [deploy it on GitHub Pages](/deploy).
8
8
9
9
See the [Quick start](/quickstart) for more details.
10
10
11
11
## Features
12
12
13
-
-Not build static html files
13
+
-No statically built html files
14
14
- Simple and lightweight (~14kB gzipped)
15
15
- Smart full-text search plugin
16
16
- Multiple themes
@@ -19,9 +19,9 @@ See the [Quick start](/quickstart) for more details.
19
19
20
20
## Examples
21
21
22
-
Check out the [Showcase](https://github.com/QingWei-Li/docsify/#showcase) to see use the docsify generated website.
22
+
Check out the [Showcase](https://github.com/QingWei-Li/docsify/#showcase) to docsify in use.
23
23
24
24
## Donate
25
25
26
-
If you think docsify is helpful to you or that my work is valuable. I am happy if you can help me [buy a cup of coffee](https://github.com/QingWei-Li/donate). :heart:
26
+
Please consider donating if you think docsify is helpful to you or that my work is valuable. I am happy if you can help me [buy a cup of coffee](https://github.com/QingWei-Li/donate). :heart:
Copy file name to clipboardExpand all lines: docs/cover.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,14 @@
1
1
# Cover
2
2
3
-
Activate the cover feature by setting `coverpage`. The detail in [Configuration#coverpage](configuration#coverpage).
3
+
Activate the cover feature by setting `coverpage` to **true**. Details are available in the [coverpage configuration paragraph](configuration#coverpage).
4
4
5
5
## Basic usage
6
6
7
-
Set `coverpage` to **true**, and create a `_coverpage.md`. You can see the effect in current website.
8
-
9
-
10
-
*index.html*
7
+
Set `coverpage` to **true**, and create a `_coverpage.md`:
11
8
12
9
```html
10
+
<!-- index.html -->
11
+
13
12
<script>
14
13
window.$docsify= {
15
14
coverpage:true
@@ -18,33 +17,34 @@ Set `coverpage` to **true**, and create a `_coverpage.md`. You can see the effec
18
17
<scriptsrc="//unpkg.com/docsify"></script>
19
18
```
20
19
21
-
*_coverpage.md*
22
20
23
21
```markdown
22
+
<!-- _coverpage.md -->
23
+
24
24
25
25
26
-
# docsify
26
+
# docsify <small>3.0</small>
27
27
28
28
> A magical documentation site generator.
29
29
30
-
- Simple and lightweight (~12kb gzipped)
30
+
- Simple and lightweight (~14kB gzipped)
31
+
- No statically built html files
31
32
- Multiple themes
32
-
- Not build static html files
33
33
34
34
35
35
[GitHub](https://github.com/QingWei-Li/docsify/)
36
-
[Get Started](#quick-start)
36
+
[Get Started](#docsify)
37
37
```
38
38
39
39
!> A document site can have only one cover page.
40
40
41
41
## Custom background
42
42
43
-
The background color is generated randomly by default. You can customize the background color or image.
44
-
45
-
*_coverpage.md*
43
+
The background color is generated randomly by default. You can customize the background color or image:
Copy file name to clipboardExpand all lines: docs/custom-navbar.md
+16-11Lines changed: 16 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,12 @@
1
1
# Custom navbar
2
2
3
-
You can create navbar in HTML file. But note that the link begins with `#/`.
3
+
## HTML
4
4
5
-
*index.html*
5
+
If you need custom navigation, you can create a HTML-based navigation bar (but note that documentation links begin with `#/`).
6
6
7
7
```html
8
+
<!-- index.html -->
9
+
8
10
<body>
9
11
<nav>
10
12
<ahref="#/">EN</a>
@@ -14,14 +16,13 @@ You can create navbar in HTML file. But note that the link begins with `#/`.
14
16
</body>
15
17
```
16
18
17
-
## Writing by Markdown
18
-
19
-
You can custom navbar by Markdown file. Set the `loadNavbar` to **true** and create a `_navbar.md`. The detail in [Configuration#load-navbar](configuration#load-navbar).
20
-
21
-
*index.html*
19
+
## Markdown
22
20
21
+
Alternatively, you can create a custom markdown-based navigation file by setting `loadNavbar` to **true** and creating `_navbar.md`. Detaile are available in the [load-navbar configuration paragraph](configuration#load-navbar).
23
22
24
23
```html
24
+
<!-- index.html -->
25
+
25
26
<script>
26
27
window.$docsify= {
27
28
loadNavbar:true
@@ -30,21 +31,25 @@ You can custom navbar by Markdown file. Set the `loadNavbar` to **true** and cre
30
31
<scriptsrc="//unpkg.com/docsify"></script>
31
32
```
32
33
33
-
*_navbar.md*
34
-
35
34
36
35
```markdown
36
+
<!-- _navbar.md -->
37
+
37
38
-[En](/)
38
39
-[chinese](/zh-cn/)
39
40
```
40
41
41
-
`_navbar.md` is loaded from each level directory. If this directory doesn't have `_navbar.md`, it will fallback to parent directory. For example, the current path is `/guide/quick-start`, the `_navbar.md` will be loaded from `/guide/_navbar.md`.
42
+
!> You need to create a `.nojekyll` in `./docs` to prevent GitHub Pages from ignoring files that begin with an underscore.
43
+
44
+
`_navbar.md` is loaded from each level directory. If the current directory doesn't have `_navbar.md`, it will fall back to the parent directory. If, for example, the current path is `/guide/quick-start`, the `_navbar.md` will be loaded from `/guide/_navbar.md`.
42
45
43
46
## Nesting
44
47
45
48
You can create sub-lists by indenting items that are under a certain parent.
46
49
47
50
```markdown
51
+
<!-- _navbar.md -->
52
+
48
53
- Getting started
49
54
-[Quick start](/quickstart)
50
55
-[Writing more pages](/more-pages)
@@ -59,7 +64,7 @@ You can create sub-lists by indenting items that are under a certain parent.
Copy file name to clipboardExpand all lines: docs/more-pages.md
+14-10Lines changed: 14 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,9 @@
1
1
# More pages
2
2
3
-
If you need more pages multi-level routing site. It is easy to achieve in docsify. A simple example: If you create a `guide.md`, then get the route is`/#/guide`.
3
+
If you need more pages, you can simply create more markdown files in your docsify directory. If you create a file named `guide.md`, then it is accessible via`/#/guide`.
4
4
5
5
For example, the directory structure is as follows:
By default, the TOC in sidebar is automatically generated based on Markdown file. You can create a Table of Contents page to list down pages in your site.
28
+
By default, the table of contents in the sidebar is automatically generated based on your markdown files. If you need a custom sidebar, then you can create your own `sidebar.md` (see [this documentation's sidebar](https://github.com/QingWei-Li/docsify/blob/master/docs/_sidebar.md) for an example):
30
29
31
-
First, you need to set `loadSidebar` to **true**. The detail in [Configuration#load-sidebar](configuration#load-sidebar).
30
+
First, you need to set `loadSidebar` to **true**. Details are available in the [configuration paragraph](configuration#load-sidebar).
32
31
33
32
```html
33
+
<!-- index.html -->
34
+
34
35
<script>
35
36
window.$docsify= {
36
37
loadSidebar:true
@@ -39,28 +40,31 @@ First, you need to set `loadSidebar` to **true**. The detail in [Configuration#l
39
40
<scriptsrc="//unpkg.com/docsify"></script>
40
41
```
41
42
42
-
Create the `_sidebar.md`
43
+
Create the `_sidebar.md`:
43
44
44
45
```markdown
46
+
<!-- docs/_sidebar.md -->
47
+
45
48
-[Home](/)
46
49
-[Guide](/guide)
47
50
```
48
51
49
-
!> Need create a `.nojekyll` in `./docs` to prevent GitHub Pages from ignoring files that begin with an underscore.
52
+
!> You need to create a `.nojekyll` in `./docs` to prevent GitHub Pages from ignoring files that begin with an underscore.
50
53
51
-
`_sidebar.md` is loaded from each level directory. If this directory doesn't have `_sidebar.md`, it will fallback to parent directory. For example, the current path is `/guide/quick-start`, the `_sidebar.md` will be loaded from `/guide/_sidebar.md`.
54
+
`_sidebar.md` is loaded from each level directory. If the current directory doesn't have `_sidebar.md`, it will fall back to the parent directory. If, for example, the current path is `/guide/quick-start`, the `_sidebar.md` will be loaded from `/guide/_sidebar.md`.
52
55
53
56
## Table of Contents
54
57
55
-
Custom sidebar can also be automatically generate TOC by setting `subMaxLevel`. The detail in [Configuration#sub-max-level](configuration#sub-max-level).
58
+
A custom sidebar can also automatically generate a table of contents by setting a `subMaxLevel`. Details are available in the [max-level configuration paragraph](configuration#sub-max-level).
0 commit comments