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/configuration.md
+11-11
Original file line number
Diff line number
Diff line change
@@ -48,7 +48,7 @@ window.$docsify = {
48
48
- Type: `String`
49
49
- Default: `null`
50
50
51
-
Configure the repository url, or a string of `username/repo` can add the [GitHub Corner](http://tholman.com/github-corners/) widget in the top right corner of the site.
51
+
Configure the repository url, or a string of `username/repo`, to add the [GitHub Corner](http://tholman.com/github-corners/) widget in the top right corner of the site.
52
52
53
53
```js
54
54
window.$docsify= {
@@ -260,7 +260,7 @@ window.$docsify = {
260
260
261
261
- Type: `String`
262
262
263
-
Website logo as it appears in the sidebar. You can resize it by using CSS.
263
+
Website logo as it appears in the sidebar. You can resize it using CSS.
264
264
265
265
```js
266
266
window.$docsify= {
@@ -337,7 +337,7 @@ window.$docsify = {
337
337
338
338
- Type: `String`
339
339
340
-
Customize the theme color. Use [CSS3 variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_variables) feature and polyfill in old browser.
340
+
Customize the theme color. Use [CSS3 variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_variables) feature and polyfill in older browsers.
341
341
342
342
```js
343
343
window.$docsify= {
@@ -367,7 +367,7 @@ window.$docsify = {
367
367
368
368
- type: `Boolean`
369
369
370
-
If `loadSidebar` and `autoHeader` are both enabled, for each link in `_sidebar.md`, prepend a header to the page before converting it to HTML. Compare[#78](https://github.com/docsifyjs/docsify/issues/78).
370
+
If `loadSidebar` and `autoHeader` are both enabled, for each link in `_sidebar.md`, prepend a header to the page before converting it to HTML. See[#78](https://github.com/docsifyjs/docsify/issues/78).
371
371
372
372
```js
373
373
window.$docsify= {
@@ -380,7 +380,7 @@ window.$docsify = {
380
380
381
381
- type: `Boolean`
382
382
383
-
Execute the script on the page. Only parse the first script tag([demo](themes)). If Vue is present, it is turned on by default.
383
+
Execute the script on the page. Only parse the first script tag([demo](themes)). If Vue is present, it is turned on by default.
384
384
385
385
```js
386
386
window.$docsify= {
@@ -410,7 +410,7 @@ window.$docsify = {
410
410
};
411
411
```
412
412
413
-
?> If this options is `false` but you don't want to emojify some specific colons, [Refer this](https://github.com/docsifyjs/docsify/issues/742#issuecomment-586313143)
413
+
?> If this option is `false` but you don't want to emojify some specific colons, [refer to this](https://github.com/docsifyjs/docsify/issues/742#issuecomment-586313143)
414
414
415
415
## mergeNavbar
416
416
@@ -497,8 +497,8 @@ window.$docsify = {
497
497
498
498
- type: `Array`
499
499
500
-
When `routerMode: 'history'`, you may face the cross-origin issues, See [#1379](https://github.com/docsifyjs/docsify/issues/1379).
501
-
In Markdown content, there is a simple way to solve it, see extends Markdown syntax `Cross-Origin link` in [helpers](helpers.md).
500
+
When `routerMode: 'history'`, you may face cross-origin issues. See [#1379](https://github.com/docsifyjs/docsify/issues/1379).
501
+
In Markdown content, there is a simple way to solve it: see extends Markdown syntax `Cross-Origin link` in [helpers](helpers.md).
502
502
503
503
```js
504
504
window.$docsify= {
@@ -570,7 +570,7 @@ window.$docsify = {
570
570
571
571
- type: `Array<string>`
572
572
573
-
List of languages that will fallback to the default language when a page is requested and it doesn't exist for the given local.
573
+
List of languages that will fallback to the default language when a page is requested and it doesn't exist for the given locale.
574
574
575
575
Example:
576
576
@@ -615,14 +615,14 @@ window.$docsify = {
615
615
};
616
616
```
617
617
618
-
> Note: The options with fallbackLanguages didn't work with the `notFoundPage` options.
618
+
> Note: The options for fallbackLanguages don't work with the `notFoundPage` options.
619
619
620
620
## topMargin
621
621
622
622
- type: `Number`
623
623
- default: `0`
624
624
625
-
Adds a space on top when scrolling content page to reach the selected section. This is useful in case you have a _sticky-header_ layout and you want to align anchors to the end of your header.
625
+
Adds a space on top when scrolling the content page to reach the selected section. This is useful in case you have a _sticky-header_ layout and you want to align anchors to the end of your header.
Copy file name to clipboardExpand all lines: docs/deploy.md
+21-21
Original file line number
Diff line number
Diff line change
@@ -4,22 +4,22 @@ Similar to [GitBook](https://www.gitbook.com), you can deploy files to GitHub Pa
4
4
5
5
## GitHub Pages
6
6
7
-
There're three places to populate your docs for your Github repository:
7
+
There are three places to populate your docs for your GitHub repository:
8
8
9
9
-`docs/` folder
10
10
- master branch
11
11
- gh-pages branch
12
12
13
-
It is recommended that you save your files to the `./docs` subfolder of the `master` branch of your repository. Then select `master branch /docs folder` as your Github Pages source in your repositories' settings page.
13
+
It is recommended that you save your files to the `./docs` subfolder of the `master` branch of your repository. Then select `master branch /docs folder` as your GitHub Pages source in your repository's settings page.
14
14
15
-
15
+
16
16
17
17
!> You can also save files in the root directory and select `master branch`.
18
18
You'll need to place a `.nojekyll` file in the deploy location (such as `/docs` or the gh-pages branch)
19
19
20
20
## GitLab Pages
21
21
22
-
If you are deploying your master branch, include`.gitlab-ci.yml` with the following script:
22
+
If you are deploying your master branch, create a`.gitlab-ci.yml` with the following script:
23
23
24
24
?> The `.public` workaround is so `cp` doesn't also copy `public/` to itself in an infinite loop.
25
25
@@ -43,9 +43,9 @@ pages:
43
43
44
44
!> You'll need to install the Firebase CLI using `npm i -g firebase-tools` after signing into the [Firebase Console](https://console.firebase.google.com) using a Google Account.
45
45
46
-
Using Terminal determine and navigate to the directory for your Firebase Project - this could be `~/Projects/Docs` etc. From there, run `firebase init`, choosing `Hosting` from the menu (use **space** to select, **arrow keys** to change options and **enter** to confirm). Follow the setup instructions.
46
+
Using a terminal, determine and navigate to the directory for your Firebase Project. This could be `~/Projects/Docs`, etc. From there, run `firebase init` and choose `Hosting` from the menu (use **space** to select, **arrow keys** to change options and **enter** to confirm). Follow the setup instructions.
47
47
48
-
You should have your `firebase.json` file looking similar to this (I changed the deployment directory from `public` to `site`):
48
+
Your `firebase.json` file should look similar to this (I changed the deployment directory from `public` to `site`):
49
49
50
50
```json
51
51
{
@@ -56,11 +56,11 @@ You should have your `firebase.json` file looking similar to this (I changed the
56
56
}
57
57
```
58
58
59
-
Once finished, build the starting template by running `docsify init ./site` (replacing site with the deployment directory you determined when running `firebase init` - public by default). Add/edit the documentation, then run `firebase deploy` from the base project directory.
59
+
Once finished, build the starting template by running `docsify init ./site` (replacing site with the deployment directory you determined when running `firebase init` - public by default). Add/edit the documentation, then run `firebase deploy` from the root project directory.
60
60
61
61
## VPS
62
62
63
-
Try following nginx config.
63
+
Use the following nginx config.
64
64
65
65
```nginx
66
66
server {
@@ -78,21 +78,21 @@ server {
78
78
79
79
1. Login to your [Netlify](https://www.netlify.com/) account.
80
80
2. In the [dashboard](https://app.netlify.com/) page, click **New site from Git**.
81
-
3. Choose a repository where you store your docs, leave the **Build Command** area blank, fill in the Publish directory area with the directory of your `index.html`, for example it should be docs if you populated it at `docs/index.html`.
81
+
3. Choose a repository where you store your docs, leave the **Build Command** area blank, and fill in the Publish directory area with the directory of your `index.html`. For example, it should be docs if you populated it at `docs/index.html`.
82
82
83
83
### HTML5 router
84
84
85
-
When using the HTML5 router, you need to set up redirect rules that redirect all requests to your `index.html`, it's pretty simple when you're using Netlify, create a file named `_redirects` in the docs directory, add this snippet to the file and you're all set:
85
+
When using the HTML5 router, you need to set up redirect rules that redirect all requests to your `index.html`. It's pretty simple when you're using Netlify. Just create a file named `_redirects` in the docs directory, add this snippet to the file, and you're all set:
86
86
87
87
```sh
88
88
/* /index.html 200
89
89
```
90
90
91
-
## ZEIT Now
91
+
## Vercel
92
92
93
-
1. Install [Now CLI](https://zeit.co/download), `npm i -g now`
93
+
1. Install [Vercel CLI](https://vercel.com/download), `npm i -g vercel`
94
94
2. Change directory to your docsify website, for example `cd docs`
95
-
3. Deploy with a single command, `now`
95
+
3. Deploy with a single command, `vercel`
96
96
97
97
## AWS Amplify
98
98
@@ -131,28 +131,28 @@ frontend:
131
131
132
132
```
133
133
134
-
6. Add the following Redirect rules in their displayed order. Note that the second record is a PNG image where you can change it with any image format you are using.
134
+
6. Add the following Redirect rules in their displayed order. Note that the second record is a PNG image where you can change it with any image format you are using.
You need prepare the initial files instead of making in container.
147
+
You need prepare the initial files instead of making them inside the container.
148
148
See the [Quickstart](https://docsify.js.org/#/quickstart) section for instructions on how to create these files manually or using [docsify-cli](https://github.com/docsifyjs/docsify-cli).
149
149
150
150
```sh
151
151
index.html
152
152
README.md
153
153
```
154
154
155
-
- Create dockerfile
155
+
- Create Dockerfile
156
156
157
157
```Dockerfile
158
158
FROM node:latest
@@ -161,10 +161,10 @@ frontend:
161
161
RUN npm install -g docsify-cli@latest
162
162
EXPOSE 3000/tcp
163
163
ENTRYPOINT docsify serve .
164
-
164
+
165
165
```
166
166
167
-
So, current directory structure should be this:
167
+
The current directory structure should be this:
168
168
169
169
```sh
170
170
index.html
@@ -181,6 +181,6 @@ frontend:
181
181
- Run docker image
182
182
183
183
```sh
184
-
docker run -itp 3000:3000 --name=docsify -v $(pwd):/docs docsify/demo
184
+
docker run -itp 3000:3000 --name=docsify -v $(pwd):/docs docsify/demo
Copy file name to clipboardExpand all lines: docs/embed-files.md
+7-2
Original file line number
Diff line number
Diff line change
@@ -10,13 +10,13 @@ For example, here is an embedded Markdown file. You only need to do this:
10
10
[filename](_media/example.md ':include')
11
11
```
12
12
13
-
Then the content of `example.md` will be displayed directly here;
13
+
Then the content of `example.md` will be displayed directly here:
14
14
15
15
[filename](_media/example.md':include')
16
16
17
17
You can check the original content for [example.md](_media/example.md':ignore').
18
18
19
-
Normally, this will compiled into a link, but in docsify, if you add `:include` it will be embedded.
19
+
Normally, this will be compiled into a link, but in docsify, if you add `:include` it will be embedded. You can use single or double quotation marks around as you like.
20
20
21
21
External links can be used too - just replace the target. If you want to use a gist URL, see [Embed a gist](#embed-a-gist) section.
22
22
@@ -73,6 +73,11 @@ Example:
73
73
74
74
If you embed the file as `iframe`, `audio` and `video`, then you may need to set the attributes of these tags.
75
75
76
+
?> Note, for the `audio` and `video` types, docsify adds the `controls` attribute by default. When you want add more attributes, the `controls` attribute need to be added manually if need be.
0 commit comments