updated to docusaurus

ctu-mrs · Nov 15, 2024 · 862e585 · 862e585
1 parent 093cba4
commit 862e585
Show file tree

Hide file tree

Showing 29,355 changed files with 2,970,923 additions and 2,901 deletions.
diff --git a/.ci/extract.sh b/.ci/extract.sh
diff --git a/.ci/install.sh b/.ci/install.sh
diff --git a/.ci/push.sh b/.ci/push.sh
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
diff --git a/.github/workflows/docusaurus.yml b/.github/workflows/docusaurus.yml
@@ -0,0 +1,55 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: [master]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+env:
+  # Hosted GitHub runners have 7 GB of memory available, let's use 6 GB
+  NODE_OPTIONS: --max-old-space-size=6144
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 22.x
+          cache: yarn
+      - name: Install dependencies
+        run: yarn add --frozen-lockfile --non-interactive remark-math@6 rehype-katex@7 @aldridged/docusaurus-plugin-lunr docusaurus-lunr-search
+      - name: Build
+        run: yarn build
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          # Upload entire repository
+          path: build
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,2 @@
-.ci/deploy_key_github
-
-build/
-
 *.swp
 *.swo
diff --git a/_config.yml b/_config.yml
diff --git a/_includes/head_custom.html b/_includes/head_custom.html
diff --git a/_includes/katex.html b/_includes/katex.html
diff --git a/_layouts/katex.html b/_layouts/katex.html
diff --git a/assets/js/mathtex-script-type.js b/assets/js/mathtex-script-type.js
diff --git a/blog/2024/11-13-new-documentation.md b/blog/2024/11-13-new-documentation.md
@@ -0,0 +1,14 @@
+---
+slug: new-documentation
+title: New documentation
+authors: [klaxalk]
+tags: [mrs]
+---
+
+New documentation
+
+We have moved the docs to docusaurus.
+This will allow us to properly version the docs and keep the version history.
+Thanks to this, the users should be able to find the right docs for the current version of the system they are using.
+
+<!-- truncate -->
diff --git a/blog/authors.yml b/blog/authors.yml
@@ -0,0 +1,7 @@
+klaxalk:
+  name: Tomas Baca
+  title: Postdoc @ MRS
+  url: https://github.com/klaxalk
+  image_url: https://github.com/klaxalk.png
+  socials:
+    github: klaxalk
diff --git a/blog/tags.yml b/blog/tags.yml
@@ -0,0 +1,9 @@
+mrs:
+  label: Multirobot Systems
+  permalink: /mrs
+  description: MRS tag description
+
+fly4future:
+  label: Fly4Future
+  permalink: /fly4future
+  description: Fly4Future tag description
diff --git a/docs/01-introduction/index.md b/docs/01-introduction/index.md
@@ -0,0 +1,5 @@
+---
+title: Introduction
+---
+
+# The MRS UAV System (MUS) documentation
diff --git a/docs/10-prerequisities/01-linux.md b/docs/10-prerequisities/01-linux.md
@@ -0,0 +1,5 @@
+---
+title: Linux OS
+---
+
+# Linux OS