Add blockbot documentation to initial webgroup docs

.github/workflows/ci.yml

@@ -4,13 +4,26 @@ on:
     branches:
       - master
       - main
+permissions:
+  contents: write
 jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
         with:
           python-version: 3.x
-      - run: pip install mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-awesome-pages-plugin mkdocs-callouts
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install -r requirements.txt
       - run: mkdocs gh-deploy --force

.gitignore

@@ -1,3 +1,9 @@
 site/
 docs/.obsidian/workspace.json
 docs/.obsidian/graph.json
+.cache/
+venv/
+.venv/
+docs/.obsidian/plugins/
+!docs/.obsidian/plugins/*/data.json
+docs/.obsidian/themes/

README.md

@@ -1,3 +1,12 @@
 # Redbrick docs
-The home for all Redbrick technical documentation  
+The home for all Redbrick technical documentation
 [docs.redbrick.dcu.ie](https://docs.redbrick.dcu.ie)
+
+## Obsidian
+For use with obsidian we reccommend the following plugins.
+   - Advanced Tables by Tony Grosinger [Github](https://github.com/tgrosinger/advanced-tables-obsidian) [Obsidian](obsidian://show-plugin?id=table-editor-obsidian)
+   - Git by Vinzent, (Denis Olehov) [Github](https://github.com/Vinzent03/obsidian-git) [Obsidian](obsidian://show-plugin?id=obsidian-git)
+   - Minimal Theme Settings by @kepano [Github](https://github.com/kepano/obsidian-minimal-settings) [Obsidian](obsidian://show-plugin?id=obsidian-minimal-settings)
+   - Linter by Virctor Tao [Github](https://github.com/platers/obsidian-linter) [Obsidian](obsidian://show-plugin?id=obsidian-linter)
+
+To Enable these plugins go to Settings > Community Plugins > Turn On Community Plugins > Browse. Search, Install and Enable each of the plugins above.

docs/.obsidian/app.json

@@ -1,7 +1,9 @@
 {
+  "promptDelete": false,
+  "alwaysUpdateLinks": true,
   "useMarkdownLinks": true,
   "newLinkFormat": "relative",
-  "alwaysUpdateLinks": true,
+  "newFileLocation": "current",
   "showUnsupportedFiles": true,
-  "attachmentFolderPath": "assets"
+  "attachmentFolderPath": "res"
 }

docs/.obsidian/appearance.json

@@ -1,7 +1,5 @@
 {
   "accentColor": "#c53030",
   "cssTheme": "Minimal",
-  "nativeMenus": false,
-  "baseFontSize": 17,
   "theme": "obsidian"
 }

docs/.obsidian/community-plugins.json

@@ -1,6 +1,6 @@
 [
   "table-editor-obsidian",
+  "obsidian-git",
   "obsidian-linter",
-  "obsidian-minimal-settings",
-  "obsidian-git"
+  "obsidian-minimal-settings"
 ]

docs/.obsidian/plugins/obsidian-git/data.json

@@ -0,0 +1,55 @@
+{
+  "commitMessage": "vault backup: {{date}}",
+  "commitDateFormat": "YYYY-MM-DD HH:mm:ss",
+  "autoSaveInterval": 0,
+  "autoPushInterval": 0,
+  "autoPullInterval": 0,
+  "autoPullOnBoot": false,
+  "disablePush": false,
+  "pullBeforePush": true,
+  "disablePopups": false,
+  "listChangedFilesInMessageBody": true,
+  "showStatusBar": true,
+  "updateSubmodules": false,
+  "syncMethod": "merge",
+  "customMessageOnAutoBackup": false,
+  "autoBackupAfterFileChange": false,
+  "treeStructure": true,
+  "refreshSourceControl": true,
+  "basePath": "",
+  "differentIntervalCommitAndPush": false,
+  "changedFilesInStatusBar": true,
+  "showedMobileNotice": true,
+  "refreshSourceControlTimer": 7000,
+  "showBranchStatusBar": true,
+  "setLastSaveToLastCommit": false,
+  "submoduleRecurseCheckout": false,
+  "gitDir": "",
+  "showFileMenu": true,
+  "lineAuthor": {
+    "show": false,
+    "followMovement": "inactive",
+    "authorDisplay": "initials",
+    "showCommitHash": false,
+    "dateTimeFormatOptions": "date",
+    "dateTimeFormatCustomString": "YYYY-MM-DD HH:mm",
+    "dateTimeTimezone": "viewer-local",
+    "coloringMaxAge": "1y",
+    "colorNew": {
+      "r": 255,
+      "g": 150,
+      "b": 150
+    },
+    "colorOld": {
+      "r": 120,
+      "g": 160,
+      "b": 255
+    },
+    "textColorCss": "var(--text-muted)",
+    "ignoreWhitespace": false,
+    "gutterSpacingFallbackLength": 5,
+    "lastShownAuthorDisplay": "initials",
+    "lastShownDateTimeFormatOptions": "date"
+  },
+  "autoCommitMessage": "vault backup: {{date}}"
+}