aboutsummaryrefslogtreecommitdiffstats
path: root/docs/README.md
diff options
context:
space:
mode:
authorEllie Huxtable <ellie@elliehuxtable.com>2023-02-25 23:29:59 +0000
committerGitHub <noreply@github.com>2023-02-25 23:29:59 +0000
commitc558da5bebfebf239dde867f36cc35d56849accf (patch)
tree2e75e2c479fa1d89632eafd8119e084243bafa5e /docs/README.md
parentRevert "Remove shortcut numbers (#708)" (#724) (diff)
downloadatuin-c558da5bebfebf239dde867f36cc35d56849accf.zip
Add fancy web docs (#725)
* Add initial site * WIP again * Replace docs with web docs * Bring back translations * Update README.md * remove images
Diffstat (limited to '')
-rw-r--r--docs/README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 00000000..aaba2fa1
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,41 @@
+# 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
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> 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.