summaryrefslogtreecommitdiff
path: root/docs/README.md
diff options
context:
space:
mode:
authorMatthieu <matthieu@developershouse.xyz>2021-10-08 14:42:05 +0400
committerMatthieu <matthieu@developershouse.xyz>2021-10-08 14:42:05 +0400
commit73fc9eff77ddbf42f5e1e0b47495fdfb2143137e (patch)
tree77423bcc2d7e3d9087716af05511e2d53810a049 /docs/README.md
parentdbfc18ed3cef55a4433870ddee77c921b996cc2b (diff)
docs: add docusaurus project
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..55d0c3e
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,33 @@
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn 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
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+```
+$ 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.