diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..bce6eb2 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# Website + +This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. + +## Installation + +```bash +npm install +``` + +**Note**: feel free to use the package manager of your choice. + +## Local Development + +```bash +npm run start +``` + +This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. + +## Build + +```bash +npm run build +``` + +This command generates static content into the `build` directory and can be served using any static contents hosting service. + +## Deployment + +Using SSH: + +```bash +USE_SSH=true npm run deploy +``` + +Not using SSH: + +```bash +GIT_USER=<Your GitHub username> npm run 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. |
