docs(ssr): update
This commit is contained in:
parent
0e74e6c15e
commit
b091f3f10d
5 changed files with 31 additions and 23 deletions
|
|
@ -8,20 +8,20 @@ See https://docsify.now.sh
|
||||||
|
|
||||||
## Quick start
|
## Quick start
|
||||||
|
|
||||||
Install `now` and `docsify-cli` in your project.
|
1. Install `now` and `docsify-cli` in your project.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm i now -g
|
npm i now -g
|
||||||
npm i docsify-cli -D
|
npm i docsify-cli -D
|
||||||
```
|
```
|
||||||
|
|
||||||
Edit `package.json`. If the documentation in `./docs` subdirectory.
|
2. Edit `package.json`. If the documentation in `./docs` subdirectory.
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"name": "my-project",
|
"name": "my-project",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"start": "docsify start docs"
|
"start": "docsify start ."
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"docs"
|
"docs"
|
||||||
|
|
@ -38,9 +38,12 @@ Edit `package.json`. If the documentation in `./docs` subdirectory.
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
3. Remove `index.html`
|
||||||
|
|
||||||
|
|
||||||
!> The `basePath` just like webpack `publicPath`. You should config it if your docs is in the subdirectory.
|
!> The `basePath` just like webpack `publicPath`. You should config it if your docs is in the subdirectory.
|
||||||
|
|
||||||
We can preview in the local to see if it works.
|
4. We can preview in the local to see if it works.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm start
|
npm start
|
||||||
|
|
@ -48,7 +51,7 @@ npm start
|
||||||
# open http://localhost:4000
|
# open http://localhost:4000
|
||||||
```
|
```
|
||||||
|
|
||||||
Publish it!
|
5. Publish it!
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
now -p
|
now -p
|
||||||
|
|
|
||||||
|
|
@ -59,8 +59,8 @@
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
</script>
|
</script>
|
||||||
<script src="//unpkg.com/docsify@next/lib/docsify.min.js"></script>
|
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
|
||||||
<script src="//unpkg.com/docsify@next/lib/plugins/search.min.js"></script>
|
<script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
|
||||||
<script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
|
<script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
|
||||||
<script src="//unpkg.com/prismjs/components/prism-markdown.min.js"></script>
|
<script src="//unpkg.com/prismjs/components/prism-markdown.min.js"></script>
|
||||||
<script src="//unpkg.com/prismjs/components/prism-nginx.min.js"></script>
|
<script src="//unpkg.com/prismjs/components/prism-nginx.min.js"></script>
|
||||||
|
|
|
||||||
|
|
@ -7,10 +7,10 @@
|
||||||
<meta name="keywords" content="doc,docs,documentation,gitbook,creator,generator,github,jekyll,github-pages">
|
<meta name="keywords" content="doc,docs,documentation,gitbook,creator,generator,github,jekyll,github-pages">
|
||||||
<meta name="description" content="A magical documentation generator.">
|
<meta name="description" content="A magical documentation generator.">
|
||||||
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
|
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
|
||||||
<link rel="stylesheet" href="/themes/vue.css" title="vue">
|
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css" title="vue">
|
||||||
<!-- <link rel="stylesheet" href="//unpkg.com/docsify@next/lib/themes/dark.css" title="dark" disabled> -->
|
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/dark.css" title="dark" disabled>
|
||||||
<!-- <link rel="stylesheet" href="//unpkg.com/docsify@next/lib/themes/buble.css" title="buble" disabled> -->
|
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/buble.css" title="buble" disabled>
|
||||||
<!-- <link rel="stylesheet" href="//unpkg.com/docsify@next/lib/themes/pure.css" title="pure" disabled> -->
|
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/pure.css" title="pure" disabled>
|
||||||
<style>
|
<style>
|
||||||
nav.app-nav li ul {
|
nav.app-nav li ul {
|
||||||
min-width: 100px;
|
min-width: 100px;
|
||||||
|
|
@ -21,8 +21,8 @@
|
||||||
<!--inject-app-->
|
<!--inject-app-->
|
||||||
<!--inject-config-->
|
<!--inject-config-->
|
||||||
</body>
|
</body>
|
||||||
<script src="/lib/docsify.js"></script>
|
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
|
||||||
<!-- <script src="/lib/plugins/search.js"></script> -->
|
<script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
|
||||||
<script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
|
<script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
|
||||||
<script src="//unpkg.com/prismjs/components/prism-markdown.min.js"></script>
|
<script src="//unpkg.com/prismjs/components/prism-markdown.min.js"></script>
|
||||||
<script src="//unpkg.com/prismjs/components/prism-nginx.min.js"></script>
|
<script src="//unpkg.com/prismjs/components/prism-nginx.min.js"></script>
|
||||||
|
|
|
||||||
12
docs/ssr.md
12
docs/ssr.md
|
|
@ -8,20 +8,20 @@ See https://docsify.now.sh
|
||||||
|
|
||||||
## Quick start
|
## Quick start
|
||||||
|
|
||||||
Install `now` and `docsify-cli` in your project.
|
1. Install `now` and `docsify-cli` in your project.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm i now -g
|
npm i now -g
|
||||||
npm i docsify-cli -D
|
npm i docsify-cli -D
|
||||||
```
|
```
|
||||||
|
|
||||||
Edit `package.json`. If the documentation in `./docs` subdirectory.
|
2. Edit `package.json`. If the documentation in `./docs` subdirectory.
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"name": "my-project",
|
"name": "my-project",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"start": "docsify start docs"
|
"start": "docsify start ."
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"docs"
|
"docs"
|
||||||
|
|
@ -38,9 +38,11 @@ Edit `package.json`. If the documentation in `./docs` subdirectory.
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
3. Remove `index.html`
|
||||||
|
|
||||||
!> The `basePath` just like webpack `publicPath`. You should config it if your docs is in the subdirectory.
|
!> The `basePath` just like webpack `publicPath`. You should config it if your docs is in the subdirectory.
|
||||||
|
|
||||||
We can preview in the local to see if it works.
|
4. We can preview in the local to see if it works.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm start
|
npm start
|
||||||
|
|
@ -48,7 +50,7 @@ npm start
|
||||||
# open http://localhost:4000
|
# open http://localhost:4000
|
||||||
```
|
```
|
||||||
|
|
||||||
Publish it!
|
5. Publish it!
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
now -p
|
now -p
|
||||||
|
|
|
||||||
|
|
@ -8,20 +8,20 @@ See https://docsify.now.sh
|
||||||
|
|
||||||
## Quick start
|
## Quick start
|
||||||
|
|
||||||
Install `now` and `docsify-cli` in your project.
|
1. Install `now` and `docsify-cli` in your project.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm i now -g
|
npm i now -g
|
||||||
npm i docsify-cli -D
|
npm i docsify-cli -D
|
||||||
```
|
```
|
||||||
|
|
||||||
Edit `package.json`. If the documentation in `./docs` subdirectory.
|
2. Edit `package.json`. If the documentation in `./docs` subdirectory.
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"name": "my-project",
|
"name": "my-project",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"start": "docsify start docs"
|
"start": "docsify start ."
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"docs"
|
"docs"
|
||||||
|
|
@ -38,9 +38,12 @@ Edit `package.json`. If the documentation in `./docs` subdirectory.
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
3. Remove `index.html`
|
||||||
|
|
||||||
!> The `basePath` just like webpack `publicPath`. You should config it if your docs is in the subdirectory.
|
!> The `basePath` just like webpack `publicPath`. You should config it if your docs is in the subdirectory.
|
||||||
|
|
||||||
We can preview in the local to see if it works.
|
4. We can preview in the local to see if it works.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm start
|
npm start
|
||||||
|
|
@ -48,7 +51,7 @@ npm start
|
||||||
# open http://localhost:4000
|
# open http://localhost:4000
|
||||||
```
|
```
|
||||||
|
|
||||||
Publish it!
|
5. Publish it!
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
now -p
|
now -p
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue