File tree Expand file tree Collapse file tree 4 files changed +2878
-3012
lines changed Expand file tree Collapse file tree 4 files changed +2878
-3012
lines changed Original file line number Diff line number Diff line change 22
33This website is built using [ Docusaurus 2] ( https://v2.docusaurus.io/ ) , a modern static website generator.
44
5- ### Installation
5+ ## Installation
66
7- ```
8- $ yarn
7+ ``` console
8+ yarn install
99```
1010
11- ### Local Development
11+ ## Local Development
1212
13- ```
14- $ yarn start
13+ ``` console
14+ yarn start
1515```
1616
1717This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
1818
19- ### Build
19+ ## Build
2020
21- ```
22- $ yarn build
21+ ``` console
22+ yarn build
2323```
2424
2525This command generates static content into the ` build ` directory and can be served using any static contents hosting service.
2626
27- ### Deployment
27+ ## Deployment
2828
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
3131```
3232
3333If 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 } */
12module . exports = {
23 title : 'My Site' ,
34 tagline : 'The tagline of my site' ,
45 url : 'https://your-docusaurus-test-site.com' ,
56 baseUrl : '/' ,
67 onBrokenLinks : 'throw' ,
8+ onBrokenMarkdownLinks : 'warn' ,
79 favicon : 'img/favicon.ico' ,
810 organizationName : 'facebook' , // Usually your GitHub org/user name.
911 projectName : 'docusaurus' , // Usually your repo name.
@@ -36,13 +38,9 @@ module.exports = {
3638 title : 'Docs' ,
3739 items : [
3840 {
39- label : 'Style Guide ' ,
41+ label : 'Getting Started ' ,
4042 to : 'docs/' ,
4143 } ,
42- {
43- label : 'Second Doc' ,
44- to : 'docs/doc2/' ,
45- } ,
4644 ] ,
4745 } ,
4846 {
Original file line number Diff line number Diff line change 11{
2- "name" : " docusaurus-example " ,
2+ "name" : " docs-v-2 " ,
33 "version" : " 0.0.0" ,
44 "private" : true ,
55 "scripts" : {
88 "build" : " docusaurus build" ,
99 "swizzle" : " docusaurus swizzle" ,
1010 "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"
1215 },
1316 "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 " ,
1720 "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 "
2023 },
2124 "browserslist" : {
2225 "production" : [
23- " >0.2 %" ,
26+ " >0.5 %" ,
2427 " not dead" ,
2528 " not op_mini all"
2629 ],
You can’t perform that action at this time.
0 commit comments