update docs

This commit is contained in:
Harvey committed 2022-04-28 14:35:45 +08:00
1 parent f2b755ef35
commit cc6151d0bd
125 files changed
+22998 -64478

No files matched your search

+20 -12
View File
@@ -2,32 +2,40 @@
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
## Installation
### Installation
```console
yarn install
```
$ yarn
```
## Local Development
### Local Development
```console
yarn start
```
$ yarn start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
## Build
### Build
```console
yarn build
```
$ yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Deployment
### Deployment
```console
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
Using SSH:
```
$ USE_SSH=true yarn deploy
```
Not using SSH:
```
$ GIT_USER=<Your GitHub username> yarn deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
@@ -40,16 +40,6 @@ module.exports = {
label: 'QQ群: 320881312',
position: 'right',
},
{
label: 'v 4.x.x',
position: 'right',
items: [
{
label: 'v 3.x.x',
href: 'https://artplayer.org/document_v3/',
},
],
},
{
label: 'English',
position: 'right',
+22602 -22805
View File
File diff suppressed because it is too large. Load diff
+37 -40
View File
@@ -1,42 +1,39 @@
{
"name": "artplayer-document",
"version": "1.0.0",
"scripts": {
"docusaurus": "docusaurus",
"start": "npx docusaurus start",
"build": "npx docusaurus build && npm run copy",
"copy": "rm -rf ../../docs/document && mv build ../../docs/document",
"commit": "git add . && git commit -m \"build document\" -n",
"swizzle": "npx docusaurus swizzle",
"deploy": "npx docusaurus deploy",
"clear": "npx docusaurus clear",
"serve": "npx docusaurus serve",
"write-translations": "npx docusaurus write-translations",
"write-heading-ids": "npx docusaurus write-heading-ids"
},
"dependencies": {
"@docusaurus/core": "2.0.0-beta.15",
"@docusaurus/preset-classic": "2.0.0-beta.15",
"@mdx-js/react": "^1.6.22",
"@svgr/webpack": "^6.1.0",
"clsx": "^1.1.1",
"docusaurus-lunr-search": "^2.1.15",
"file-loader": "^6.2.0",
"prism-react-renderer": "^1.2.1",
"react": "^17.0.2",
"react-dom": "^17.0.2",
"url-loader": "^4.1.1"
},
"browserslist": {
"production": [
">0.5%",
"not dead",
"not op_mini all"
],
"development": [
"last 1 chrome version",
"last 1 firefox version",
"last 1 safari version"
]
}
"name": "artplayer-document",
"version": "2.0.0",
"private": true,
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
"build": "docusaurus build && npm run copy",
"copy": "rm -rf ../../docs/document && mv build ../../docs/document",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",
"serve": "docusaurus serve",
"write-translations": "docusaurus write-translations",
"write-heading-ids": "docusaurus write-heading-ids"
},
"dependencies": {
"@docusaurus/core": "2.0.0-beta.18",
"@docusaurus/preset-classic": "2.0.0-beta.18",
"@mdx-js/react": "^1.6.22",
"clsx": "^1.1.1",
"docusaurus-lunr-search": "^2.1.15",
"prism-react-renderer": "^1.3.1",
"react": "^17.0.2",
"react-dom": "^17.0.2"
},
"browserslist": {
"production": [
">0.5%",
"not dead",
"not op_mini all"
],
"development": [
"last 1 chrome version",
"last 1 firefox version",
"last 1 safari version"
]
}
}
File diff suppressed because it is too large. Load diff