misc(v2): nitpicky formatting

This commit is contained in:
Yangshun Tay 2019-12-04 00:55:52 -08:00
parent e0425358ee
commit 4927f764e5
8 changed files with 45 additions and 32 deletions

View file

@ -1,6 +1,6 @@
# Website
This website is built using Docusaurus 2, a modern static website generator.
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
### Installation
@ -27,7 +27,7 @@ This command generates static content into the `build` directory and can be serv
### Deployment
```
$ GIT_USER=<Your GitHub username> USE_SSH=1 yarn deploy
$ GIT_USER=<Your GitHub username> USE_SSH=true 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.

View file

@ -1,14 +1,14 @@
# dependencies
# Dependencies
/node_modules
# production
# Production
/build
# generated files
# Generated files
.docusaurus
.cache-loader
# misc
# Misc
.DS_Store
.env.local
.env.development.local
@ -17,4 +17,4 @@
npm-debug.log*
yarn-debug.log*
yarn-error.log*
yarn-error.log*