added boilerplate mkdocs along with github actions

Signed-off-by: Bendik Dyrli <[email protected]>
uiano · Sep 12, 2024 · ae007b8 · ae007b8
1 parent 3045efd
commit ae007b8
Show file tree

Hide file tree

Showing 8 changed files with 831 additions and 1 deletion.
diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml
@@ -0,0 +1,22 @@
+name: Publish docs via GitHub Pages
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout master
+        uses: actions/checkout@v1
+      - uses: divideprojects/poetry-export-requirements-action@v1
+        with:
+          without-hashes: true
+          outfile-name: requirements.txt
+      - name: Deploy docs
+        uses: mhausenblas/mkdocs-deploy-gh-pages@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          REQUIREMENTS: requirements.txt
diff --git a/README.md b/README.md
@@ -1 +1,6 @@
-# test-wiki
+# grimstad-courses-wiki
+
+- plugins
+  - https://squidfunk.github.io/mkdocs-material/reference/
+- documentation
+  - https://www.mkdocs.org/user-guide/
diff --git a/docs/IKT100/faq.md b/docs/IKT100/faq.md
@@ -0,0 +1 @@
+# faq
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,3 @@
+# grimstad-courses-wiki
+
+Denne wiki siden er ment for å gjøre det lettere å finne og anvende guider for å f.eks koble seg på virtuelle maskiner, eller mer spesifikt for fag ol.
diff --git a/docs/vm.md b/docs/vm.md
@@ -0,0 +1,10 @@
+# hvordan koble seg på en virtuell maskin
+
+...
+..
+..
+....
+
+```bash
+ssh 10.225.x.y -l bendid13
+```
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,22 @@
+site_name: grimstad-courses-wiki
+repo_url: https://github.com/uiano/grimstad-courses-wiki
+repo_name: grimstad-courses-wiki
+
+theme:
+  name: material
+  font: true
+
+  font:
+    text: Roboto
+    code: Roboto Mono
+
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+  - toc:
+      permalink: "#"
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,17 @@
+[tool.poetry]
+name = "grimstad-courses-wiki"
+version = "0.1.0"
+description = ""
+authors = ["Bendik Dyrli <[email protected]>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.11"
+mkdocs-material = "^9.5.34"
+pymdown-extensions = "^10.9"
+mkdocs = "^1.6.1"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# grimstad-courses-wiki

		Denne wiki siden er ment for å gjøre det lettere å finne og anvende guider for å f.eks koble seg på virtuelle maskiner, eller mer spesifikt for fag ol.