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/deploy.md
+19-19
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,11 +78,11 @@ 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
@@ -117,7 +117,7 @@ version: 0.1
117
117
frontend:
118
118
phases:
119
119
build:
120
-
commands:
120
+
commands:
121
121
- echo "Nothing to build"
122
122
artifacts:
123
123
baseDirectory: /docs
@@ -128,28 +128,28 @@ frontend:
128
128
129
129
```
130
130
131
-
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.
131
+
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.
144
+
You need prepare the initial files instead of making them inside the container.
145
145
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).
146
146
147
147
```sh
148
148
index.html
149
149
README.md
150
150
```
151
151
152
-
- Create dockerfile
152
+
- Create Dockerfile
153
153
154
154
```Dockerfile
155
155
FROM node:latest
@@ -158,10 +158,10 @@ frontend:
158
158
RUN npm install -g docsify-cli@latest
159
159
EXPOSE 3000/tcp
160
160
ENTRYPOINT docsify serve .
161
-
161
+
162
162
```
163
163
164
-
So, current directory structure should be this:
164
+
The current directory structure should be this:
165
165
166
166
```sh
167
167
index.html
@@ -178,6 +178,6 @@ frontend:
178
178
- Run docker image
179
179
180
180
```sh
181
-
docker run -itp 3000:3000 --name=docsify -v $(pwd):/docs docsify/demo
181
+
docker run -itp 3000:3000 --name=docsify -v $(pwd):/docs docsify/demo
Copy file name to clipboardexpand all lines: docs/embed-files.md
+3-3
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. You can use single or double quotation marks around as you like.
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,7 +73,7 @@ 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.
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.
Copy file name to clipboardexpand all lines: docs/pwa.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,11 @@
2
2
3
3
[Progressive Web Apps](https://developers.google.com/web/progressive-web-apps/) (PWA) are experiences that combine the best of the web with the best of apps. We can enhance our website with service workers to work **offline** or on low-quality networks.
4
4
5
-
It is also very easy to use it.
5
+
It is also very easy to use.
6
6
7
7
## Create serviceWorker
8
8
9
-
Create a `sw.js` file in your documents root directory and copy the following code:
9
+
Create a `sw.js` file in your project's root directory and copy the following code:
Copy file name to clipboardexpand all lines: docs/vue.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Vue compatibility
2
2
3
-
Docsify allows Vue content to be added directly to you markdown pages. This can greatly simplify working with data and adding reactivity to your site.
3
+
Docsify allows Vue content to be added directly to your markdown pages. This can greatly simplify working with data and adding reactivity to your site.
4
4
5
5
To get started, add Vue [2.x](https://vuejs.org) or [3.x](https://v3.vuejs.org) to your `index.html` file. Choose the production version for your live site or the development version for helpful console warnings and [Vue.js devtools](https://github.com/vuejs/vue-devtools) support.
0 commit comments