From 079be2532e2a533f8a033f86b5285247cfe314e5 Mon Sep 17 00:00:00 2001 From: Nick Slowinski Date: Mon, 23 Jan 2023 15:30:26 +0100 Subject: [PATCH] add base for docs --- .gitignore | 1 + .vscode/settings.json | 12 ++++++++++++ LIESMICH.md | 13 +++++++++++++ docs/index.md | 3 +++ mkdocs.yml | 41 +++++++++++++++++++++++++++++++++++++++++ requirments.txt | 30 ++++++++++++++++++++++++++++++ 6 files changed, 100 insertions(+) create mode 100644 .gitignore create mode 100644 .vscode/settings.json create mode 100644 LIESMICH.md create mode 100644 docs/index.md create mode 100644 mkdocs.yml create mode 100644 requirments.txt diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ae412d6 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +env/ \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..0ba6ac0 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,12 @@ +{ + "yaml.schemas": { + "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml" + }, + "yaml.customTags": [ + "!ENV scalar", + "!ENV sequence", + "tag:yaml.org,2002:python/name:materialx.emoji.to_svg", + "tag:yaml.org,2002:python/name:materialx.emoji.twemoji", + "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format" + ] +} \ No newline at end of file diff --git a/LIESMICH.md b/LIESMICH.md new file mode 100644 index 0000000..ecaf2fa --- /dev/null +++ b/LIESMICH.md @@ -0,0 +1,13 @@ +# Willkommen zur Dokumentation von Nick Slowinski +⚠️ **WICHTIGER HINWEIS: Diese Dokumentation ist bisher unvollständig und teilweise erstmal nur in Stichpunktartiger Ausführung!** ⚠️ +## Entwicklungsumgebung +Es wird eine funktionstüchtige Installation von *Material for MkDocs* in Version 9 benötigt. +### Python +``` +pip install --user virtualenv +python3 -m venv env +source env/bin/activate +pip install mkdocs-material=="9.*" +``` +### Docker +Dieser Abschnitt wird später ergänzt. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..8f0119f --- /dev/null +++ b/docs/index.md @@ -0,0 +1,3 @@ +# Willkommen zur Dokumentation von nick-slowinski.de +!!! info + Diese Dokumentation befindet sich noch im Aufbau und wird nach für nach vervollständigt. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..d65e5f4 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,41 @@ +site_name: Dokumentation von nick-slowinski.de +repo_url: https://git.nick-slowinski.de/nick-slowinski.de/docs + +plugins: + - git-revision-date-localized: + type: iso_datetime + enable_creation_date: true + fallback_to_build_date: true + +markdown_extensions: + - admonition + - pymdownx.details + - pymdownx.superfences + - pymdownx.tasklist: + custom_checkbox: true + +theme: + name: material + language: de + icon: + repo: simple/gitea + palette: + # Palette toggle for automatic mode + - media: "(prefers-color-scheme)" + toggle: + icon: material/brightness-auto + name: In den Helligkeitsmodus wechseln + + # Palette toggle for light mode + - media: "(prefers-color-scheme: light)" + scheme: default + toggle: + icon: material/brightness-7 + name: In den Dunkelmodus wechseln + + # Palette toggle for dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + toggle: + icon: material/brightness-4 + name: Zur Systempräferenz wechseln \ No newline at end of file diff --git a/requirments.txt b/requirments.txt new file mode 100644 index 0000000..b9dede9 --- /dev/null +++ b/requirments.txt @@ -0,0 +1,30 @@ +Babel==2.11.0 +certifi==2022.12.7 +charset-normalizer==3.0.1 +click==8.1.3 +colorama==0.4.6 +ghp-import==2.1.0 +gitdb==4.0.10 +GitPython==3.1.30 +idna==3.4 +Jinja2==3.1.2 +Markdown==3.3.7 +MarkupSafe==2.1.2 +mergedeep==1.3.4 +mkdocs==1.4.2 +mkdocs-git-revision-date-localized-plugin==1.1.0 +mkdocs-material==9.0.6 +mkdocs-material-extensions==1.1.1 +packaging==23.0 +Pygments==2.14.0 +pymdown-extensions==9.9.2 +python-dateutil==2.8.2 +pytz==2022.7.1 +PyYAML==6.0 +pyyaml_env_tag==0.1 +regex==2022.10.31 +requests==2.28.2 +six==1.16.0 +smmap==5.0.0 +urllib3==1.26.14 +watchdog==2.2.1