From bea36ba75c18b8db0c87e2631684ea50ff1d76ae Mon Sep 17 00:00:00 2001 From: profitroll Date: Fri, 29 Mar 2024 20:44:51 +0100 Subject: [PATCH] Initial content commit --- .renovaterc | 20 +++++++++++++ .vscode/settings.json | 13 +++++++++ .vscode/tasks.json | 45 +++++++++++++++++++++++++++++ README.md | 3 +- docs/index.md | 17 +++++++++++ docs/stylesheets/extra.css | 5 ++++ mkdocs.yml | 58 ++++++++++++++++++++++++++++++++++++++ requirements.txt | 1 + 8 files changed, 161 insertions(+), 1 deletion(-) create mode 100644 .renovaterc create mode 100644 .vscode/settings.json create mode 100644 .vscode/tasks.json create mode 100644 docs/index.md create mode 100644 docs/stylesheets/extra.css create mode 100644 mkdocs.yml create mode 100644 requirements.txt diff --git a/.renovaterc b/.renovaterc new file mode 100644 index 0000000..c416352 --- /dev/null +++ b/.renovaterc @@ -0,0 +1,20 @@ +{ + "$schema": "https://docs.renovatebot.com/renovate-schema.json", + "extends": [ + "config:base" + ], + "baseBranches": [ + "dev" + ], + "packageRules": [ + { + "matchUpdateTypes": [ + "minor", + "patch", + "pin", + "digest" + ], + "automerge": true + } + ] +} \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..e77fb3c --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,13 @@ +{ + "yaml.schemas": + { "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml" }, + "yaml.customTags": + [ + "!ENV scalar", + "!ENV sequence", + "!relative scalar", + "tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg", + "tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji", + "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format", + ], +} diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 0000000..903dd03 --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,45 @@ +{ + // See https://go.microsoft.com/fwlink/?LinkId=733558 + // for the documentation about the tasks.json format + "version": "2.0.0", + "tasks": [ + { + "label": "Build", + "type": "shell", + "windows": { + "command": ".venv\\Scripts\\mkdocs.exe", + "args": [ + "build" + ] + }, + "linux": { + "command": ".venv/bin/mkdocs", + "args": [ + "build" + ] + }, + "problemMatcher": [], + "group": { + "kind": "build", + "isDefault": true + } + }, + { + "label": "Serve", + "type": "shell", + "windows": { + "command": ".venv\\Scripts\\mkdocs.exe", + "args": [ + "serve" + ] + }, + "linux": { + "command": ".venv/bin/mkdocs", + "args": [ + "serve" + ] + }, + "problemMatcher": [] + } + ] +} \ No newline at end of file diff --git a/README.md b/README.md index 7dd802a..c1d47ae 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,3 @@ -# docs +# END PLAY Documentation +A small collection of general documentation concerning END PLAY Studio. diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..000ea34 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,17 @@ +# Welcome to MkDocs + +For full documentation visit [mkdocs.org](https://www.mkdocs.org). + +## Commands + +* `mkdocs new [dir-name]` - Create a new project. +* `mkdocs serve` - Start the live-reloading docs server. +* `mkdocs build` - Build the documentation site. +* `mkdocs -h` - Print help message and exit. + +## Project layout + + mkdocs.yml # The configuration file. + docs/ + index.md # The documentation homepage. + ... # Other markdown pages, images and other files. diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css new file mode 100644 index 0000000..033002d --- /dev/null +++ b/docs/stylesheets/extra.css @@ -0,0 +1,5 @@ +:root { + --md-primary-fg-color: #E03C33; + --md-primary-fg-color--light: #E03C33; + --md-primary-fg-color--dark: #E03C33; +} \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..b931946 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,58 @@ +site_name: END PLAY Docs +extra_css: + - stylesheets/extra.css +theme: + name: material + features: + - announce.dismiss + - content.action.edit + - content.action.view + - content.code.annotate + - content.code.copy + # - content.code.select + # - content.footnote.tooltips + # - content.tabs.link + - content.tooltips + # - header.autohide + # - navigation.expand + - navigation.footer + - navigation.indexes + # - navigation.instant + # - navigation.instant.prefetch + # - navigation.instant.progress + # - navigation.prune + - navigation.sections + - navigation.tabs + # - navigation.tabs.sticky + - navigation.top + - navigation.tracking + - search.highlight + - search.share + - search.suggest + - toc.follow + # - toc.integrate + palette: + - media: "(prefers-color-scheme)" + toggle: + icon: material/link + name: Switch to light mode + - media: "(prefers-color-scheme: light)" + scheme: default + primary: custom + accent: custom + toggle: + icon: material/toggle-switch + name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: custom + accent: custom + toggle: + icon: material/toggle-switch-off + name: Switch to system preference + font: + text: Roboto + code: Roboto Mono + favicon: assets/favicon.png + icon: + logo: logo diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..0c686c7 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +mkdocs-material~=9.5.15 \ No newline at end of file