File tree 4 files changed +2878
-3012
lines changed
4 files changed +2878
-3012
lines changed Original file line number Diff line number Diff line change 2
2
3
3
This website is built using [ Docusaurus 2] ( https://v2.docusaurus.io/ ) , a modern static website generator.
4
4
5
- ### Installation
5
+ ## Installation
6
6
7
- ```
8
- $ yarn
7
+ ``` console
8
+ yarn install
9
9
```
10
10
11
- ### Local Development
11
+ ## Local Development
12
12
13
- ```
14
- $ yarn start
13
+ ``` console
14
+ yarn start
15
15
```
16
16
17
17
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
18
18
19
- ### Build
19
+ ## Build
20
20
21
- ```
22
- $ yarn build
21
+ ``` console
22
+ yarn build
23
23
```
24
24
25
25
This command generates static content into the ` build ` directory and can be served using any static contents hosting service.
26
26
27
- ### Deployment
27
+ ## Deployment
28
28
29
- ```
30
- $ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
29
+ ``` console
30
+ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
31
31
```
32
32
33
33
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.
Original file line number Diff line number Diff line change
1
+ /** @type {import('@docusaurus/types').DocusaurusConfig } */
1
2
module . exports = {
2
3
title : 'My Site' ,
3
4
tagline : 'The tagline of my site' ,
4
5
url : 'https://your-docusaurus-test-site.com' ,
5
6
baseUrl : '/' ,
6
7
onBrokenLinks : 'throw' ,
8
+ onBrokenMarkdownLinks : 'warn' ,
7
9
favicon : 'img/favicon.ico' ,
8
10
organizationName : 'facebook' , // Usually your GitHub org/user name.
9
11
projectName : 'docusaurus' , // Usually your repo name.
@@ -36,13 +38,9 @@ module.exports = {
36
38
title : 'Docs' ,
37
39
items : [
38
40
{
39
- label : 'Style Guide ' ,
41
+ label : 'Getting Started ' ,
40
42
to : 'docs/' ,
41
43
} ,
42
- {
43
- label : 'Second Doc' ,
44
- to : 'docs/doc2/' ,
45
- } ,
46
44
] ,
47
45
} ,
48
46
{
Original file line number Diff line number Diff line change 1
1
{
2
- "name" : " docusaurus-example " ,
2
+ "name" : " docs-v-2 " ,
3
3
"version" : " 0.0.0" ,
4
4
"private" : true ,
5
5
"scripts" : {
8
8
"build" : " docusaurus build" ,
9
9
"swizzle" : " docusaurus swizzle" ,
10
10
"deploy" : " docusaurus deploy" ,
11
- "serve" : " docusaurus serve"
11
+ "clear" : " docusaurus clear" ,
12
+ "serve" : " docusaurus serve" ,
13
+ "write-translations" : " docusaurus write-translations" ,
14
+ "write-heading-ids" : " docusaurus write-heading-ids"
12
15
},
13
16
"dependencies" : {
14
- "@docusaurus/core" : " 2.0.0-alpha.63 " ,
15
- "@docusaurus/preset-classic" : " 2.0.0-alpha.63 " ,
16
- "@mdx-js/react" : " ^1.5.8 " ,
17
+ "@docusaurus/core" : " 2.0.0-alpha.72 " ,
18
+ "@docusaurus/preset-classic" : " 2.0.0-alpha.72 " ,
19
+ "@mdx-js/react" : " ^1.6.21 " ,
17
20
"clsx" : " ^1.1.1" ,
18
- "react" : " ^16.8.4 " ,
19
- "react-dom" : " ^16.8.4 "
21
+ "react" : " ^17.0.1 " ,
22
+ "react-dom" : " ^17.0.1 "
20
23
},
21
24
"browserslist" : {
22
25
"production" : [
23
- " >0.2 %" ,
26
+ " >0.5 %" ,
24
27
" not dead" ,
25
28
" not op_mini all"
26
29
],
You can’t perform that action at this time.
0 commit comments