Skip to content

Commit ae007b8

Browse files
author
Bendik Dyrli
committed
added boilerplate mkdocs along with github actions
Signed-off-by: Bendik Dyrli <[email protected]>
1 parent 3045efd commit ae007b8

File tree

8 files changed

+831
-1
lines changed

8 files changed

+831
-1
lines changed

.github/workflows/main.yaml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Publish docs via GitHub Pages
2+
on:
3+
push:
4+
branches:
5+
- main
6+
7+
jobs:
8+
build:
9+
name: Deploy docs
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout master
13+
uses: actions/checkout@v1
14+
- uses: divideprojects/poetry-export-requirements-action@v1
15+
with:
16+
without-hashes: true
17+
outfile-name: requirements.txt
18+
- name: Deploy docs
19+
uses: mhausenblas/mkdocs-deploy-gh-pages@master
20+
env:
21+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
22+
REQUIREMENTS: requirements.txt

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
1-
# test-wiki
1+
# grimstad-courses-wiki
2+
3+
- plugins
4+
- https://squidfunk.github.io/mkdocs-material/reference/
5+
- documentation
6+
- https://www.mkdocs.org/user-guide/

docs/IKT100/faq.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# faq

docs/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# grimstad-courses-wiki
2+
3+
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.

docs/vm.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# hvordan koble seg på en virtuell maskin
2+
3+
...
4+
..
5+
..
6+
....
7+
8+
```bash
9+
ssh 10.225.x.y -l bendid13
10+
```

mkdocs.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
site_name: grimstad-courses-wiki
2+
repo_url: https://github.com/uiano/grimstad-courses-wiki
3+
repo_name: grimstad-courses-wiki
4+
5+
theme:
6+
name: material
7+
font: true
8+
9+
font:
10+
text: Roboto
11+
code: Roboto Mono
12+
13+
markdown_extensions:
14+
- pymdownx.highlight:
15+
anchor_linenums: true
16+
line_spans: __span
17+
pygments_lang_class: true
18+
- pymdownx.inlinehilite
19+
- pymdownx.snippets
20+
- pymdownx.superfences
21+
- toc:
22+
permalink: "#"

poetry.lock

Lines changed: 750 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
[tool.poetry]
2+
name = "grimstad-courses-wiki"
3+
version = "0.1.0"
4+
description = ""
5+
authors = ["Bendik Dyrli <[email protected]>"]
6+
readme = "README.md"
7+
8+
[tool.poetry.dependencies]
9+
python = "^3.11"
10+
mkdocs-material = "^9.5.34"
11+
pymdown-extensions = "^10.9"
12+
mkdocs = "^1.6.1"
13+
14+
15+
[build-system]
16+
requires = ["poetry-core"]
17+
build-backend = "poetry.core.masonry.api"

0 commit comments

Comments
 (0)