From 3089fe38a988ebe7fbc82d3e38cb5f723bfa11fc Mon Sep 17 00:00:00 2001 From: "ishak jmilou.ishak" Date: Wed, 18 Sep 2024 13:12:26 +0200 Subject: [PATCH 1/3] testing mkdocs --- .gitmodules | 3 +++ mdocotion | 1 + 2 files changed, 4 insertions(+) create mode 100644 .gitmodules create mode 160000 mdocotion diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..14eacbb --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "mdocotion"] + path = mdocotion + url = https://uva-hva.gitlab.host/hbo-ict/mdocotion.git diff --git a/mdocotion b/mdocotion new file mode 160000 index 0000000..672870b --- /dev/null +++ b/mdocotion @@ -0,0 +1 @@ +Subproject commit 672870b9455868443edce19fd1ff25816b32d0ad From 937ad4fd32af8e6e97a671cd443de47424b303c2 Mon Sep 17 00:00:00 2001 From: "ishak jmilou.ishak" Date: Wed, 18 Sep 2024 13:12:45 +0200 Subject: [PATCH 2/3] testing mkdocs --- .gitignore | 1 + .gitlab-ci.yml | 21 +++++++++++++++++++++ docs/home.md | 1 + mkdocs.yml | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 73 insertions(+) create mode 100644 .gitignore create mode 100644 .gitlab-ci.yml create mode 100644 docs/home.md create mode 100644 mkdocs.yml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1795c8d --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.history \ No newline at end of file diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..1b72c92 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,21 @@ +image: python:3.9-slim + +before_script: + - time apt update + - time pip install -r requirements.txt + - time cd mdocotion && python setup.py install && cd .. + +pages: + stage: deploy + tags: + - hva + script: + - time mkdocs build --site-dir public + artifacts: + paths: + - public + rules: + - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH + +variables: + GIT_SUBMODULE_STRATEGY: recursive \ No newline at end of file diff --git a/docs/home.md b/docs/home.md new file mode 100644 index 0000000..d8dffd5 --- /dev/null +++ b/docs/home.md @@ -0,0 +1 @@ +# home \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..124face --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,50 @@ +site_name: TI Portfolio +site_description: HBO-ICT Technische Informatica Portfolio +site_author: HBO-ICT +copyright: Copyright 2024 Hogeschool van Amsterdam + +theme: + name: material + custom_dir: mdocotion/ + features: + # - content.tabs.link + - navigation.instant + palette: + + # Palette toggle for light mode + - scheme: default + toggle: + icon: material/brightness-7 + name: Switch to dark mode + + # Palette toggle for dark mode + - scheme: slate + toggle: + icon: material/brightness-4 + name: Switch to light mode + +plugins: + - search + - mermaid2 + - awesome-pages + - mkdocs-video + # - section-index + # - autolinks + - macros: + modules: [mkdocs_macros_mdocotion] + +markdown_extensions: + - attr_list + - md_in_html + - fenced_code + - pymdownx.highlight: + linenums: true + use_pygments: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.tabbed + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format From b5207aab9bc4314819540d38e6fe164cbd2cc2ff Mon Sep 17 00:00:00 2001 From: "ishak jmilou.ishak" Date: Wed, 18 Sep 2024 13:22:02 +0200 Subject: [PATCH 3/3] mkdocs requirements file --- requirements.txt | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 requirements.txt diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..87f74a2 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,11 @@ +mkdocs ~= 1.5.3 +Jinja2==3.1.0 +mkdocs-material ~= 9.5.14 +mkdocs-video ~= 1.5 +mkdocs-mermaid2-plugin ~= 0.6.0 +mkdocs-macros-plugin ~= 0.7.0 +mkdocs-awesome-pages-plugin ~= 2.8.0 +mkdocs-autolinks-plugin ~= 0.6.0 +mkdocs-section-index ~= 0.3.5 +gitpython ~= 3.1.27 +mkdocs-material-extensions \ No newline at end of file