Upgrade doc and start it up again

batleforc · Jul 29, 2023 · 9af9275 · 9af9275
1 parent b5f9586
commit 9af9275
Show file tree

Hide file tree

Showing 55 changed files with 7,606 additions and 15,144 deletions.
diff --git a/.gitignore b/.gitignore
@@ -17,4 +17,4 @@
 
 npm-debug.log*
 yarn-debug.log*
-yarn-error.log*
+yarn-error.log*
diff --git a/README.md b/README.md
@@ -1,9 +1,41 @@
-# Doc Subproject
+# Website
 
-A subproject that contains documentation.
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
 
-in order to start it please use the following command:
+### Installation
 
-```sh
- yarn start
 ```
+$ 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/bck_blog/2019-05-28-first-blog-post.md b/bck_blog/2019-05-28-first-blog-post.md
diff --git a/bck_blog/2019-05-29-long-blog-post.md b/bck_blog/2019-05-29-long-blog-post.md
diff --git a/bck_blog/2021-08-01-mdx-blog-post.mdx b/bck_blog/2021-08-01-mdx-blog-post.mdx
diff --git a/bck_blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg b/bck_blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg
diff --git a/bck_blog/2021-08-26-welcome/index.md b/bck_blog/2021-08-26-welcome/index.md
diff --git a/bck_blog/authors.yml b/bck_blog/authors.yml
diff --git a/bck_docs/intro.md b/bck_docs/intro.md
diff --git a/bck_docs/tutorial-basics/_category_.json b/bck_docs/tutorial-basics/_category_.json
diff --git a/bck_docs/tutorial-basics/congratulations.md b/bck_docs/tutorial-basics/congratulations.md
diff --git a/bck_docs/tutorial-basics/create-a-blog-post.md b/bck_docs/tutorial-basics/create-a-blog-post.md
diff --git a/bck_docs/tutorial-basics/create-a-document.md b/bck_docs/tutorial-basics/create-a-document.md
diff --git a/bck_docs/tutorial-basics/create-a-page.md b/bck_docs/tutorial-basics/create-a-page.md