diff options
| author | Pete Johanson <peter@peterjohanson.com> | 2020-05-25 21:33:21 -0400 |
|---|---|---|
| committer | Pete Johanson <peter@peterjohanson.com> | 2020-05-25 21:33:21 -0400 |
| commit | e00408d7464e597bab543ff61a4af8b9beb17629 (patch) | |
| tree | 1b60b9b57b9ede7656f31d4dd390891cb7135b07 /docs/README.md | |
| parent | 96b87b2594d590b9eed009803218f773716fd2ac (diff) | |
Initial work on basic documentation.
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..3e7c9e6 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,26 @@ +# Website + +This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator. + +### Installation + +``` +$ npm ci +``` + +### Local Development + +``` +$ npm start +``` + +This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server. + +### Build + +``` +$ npm build +``` + +This command generates static content into the `build` directory and can be served using any static contents hosting service. + |