new documentation page (WIP) #275

jcubic · Feb 12, 2024 · 48c0389 · 48c0389
1 parent c742601
commit 48c0389
Show file tree

Hide file tree

Showing 79 changed files with 16,693 additions and 784 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1,6 +1,8 @@
 * text eol=lf
 .* text eol=lf
 dist/* binary
+*png binary
+*ico binary
 package-lock.json binary
 assets/classDiagram.svg binary
 assets/*.png binary

diff --git a/docs/.gitignore b/docs/.gitignore
@@ -1,5 +1,20 @@
-_site
-.sass-cache
-.jekyll-cache
-.jekyll-metadata
-vendor
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/Gemfile b/docs/Gemfile
diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus](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.
diff --git a/docs/_config.yaml b/docs/_config.yaml
diff --git a/docs/_includes/base_head.html b/docs/_includes/base_head.html
diff --git a/docs/_includes/footer.html b/docs/_includes/footer.html
diff --git a/docs/_includes/logo.html b/docs/_includes/logo.html
diff --git a/docs/_includes/nav.html b/docs/_includes/nav.html
diff --git a/docs/_includes/preamble.html b/docs/_includes/preamble.html
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html