1- # Website
1+ # Docs Site
22
33This website is built using [ Docusaurus 2] ( https://docusaurus.io/ ) , a modern
44static website generator.
55
6- ### Docs Sourcer
6+ ## Docs Sourcer
77
88All of the content that we see on the docs site is rendered to the top level
99` docs/ ` folder by the
@@ -16,24 +16,24 @@ pull in tagged content from other files, located in other GitHub repos, pull in
1616images and auto-correct links. This will allow content creators to have more
1717features when authoring content.
1818
19- ### Content creation
19+ ## Content creation
2020
2121All manually created MarkDown source content lives in the ` _docs-sources/ `
2222folder. The top level ` docs/ ` folder contains the _ generated_ output that
2323results after the ` docs-sourcer ` processes the ` _docs-sources/ ` directory.
2424Grunts should ** never edit any of the MarkDown files in the ` docs/ ` folder
2525directly** . We should always be editing the content in ` _docs-sources/ ` .
2626
27- ### Installation of dependencies
27+ ## Installation of dependencies
2828
29- ```
30- $ yarn
29+ ``` sh
30+ yarn
3131```
3232
33- ### Local development
33+ ## Local development
3434
35- ```
36- $ yarn start
35+ ``` sh
36+ yarn start
3737```
3838
3939This command starts a local development server and opens up a browser window.
@@ -43,7 +43,16 @@ you edit a file in `_docs-sources/` then the `docs-sourcer` will automatically
4343re-run to regenerate the output files. Docusaurus will then hot-reload that
4444content so that to the end user, they have "live reloading" while authoring.
4545
46- ### Committing changes to docs
46+ ### Run production build locally
47+
48+ ``` sh
49+ yarn build && yarn serve
50+ ```
51+
52+ This will create and serve a production build. This can be used to verify the
53+ expected behaviors in a production environment and view the Google analytics.
54+
55+ ## Committing changes to docs
4756
4857While authoring local content, you will exclusively be making your changes in
4958the ` _docs-sources/ ` folder. The ` docs-sourcer ` will then pre-process and
@@ -55,22 +64,22 @@ Generated content should be up to date if you are previewing locally while
5564editing but you may wish to manually regenerate the output (see section below)
5665to ensure it is totally up to date.
5766
58- ### Manually generating docs output
67+ ## Manually generating docs output
5968
6069It's possible to manually regenerate output content from the sources in
6170` _docs-sources/ ` :
6271
63- ```
72+ ``` sh
6473yarn regenerate:local
6574```
6675
6776This command can be run at any time, regardless of whether ` yarn start ` is
6877currently running.
6978
70- ### Build
79+ ## Build
7180
72- ```
73- $ yarn build
81+ ``` sh
82+ yarn build
7483```
7584
7685This command generates static content into the ` build ` directory and can be
0 commit comments