Initial content commit

This commit is contained in:
Profitroll 2024-03-29 20:44:51 +01:00
parent 8514d84181
commit bea36ba75c
Signed by: profitroll
GPG Key ID: FA35CAB49DACD3B2
8 changed files with 161 additions and 1 deletions

20
.renovaterc Normal file
View File

@ -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
}
]
}

13
.vscode/settings.json vendored Normal file
View File

@ -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",
],
}

45
.vscode/tasks.json vendored Normal file
View File

@ -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": []
}
]
}

View File

@ -1,2 +1,3 @@
# docs
# END PLAY Documentation
A small collection of general documentation concerning END PLAY Studio.

17
docs/index.md Normal file
View File

@ -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.

View File

@ -0,0 +1,5 @@
:root {
--md-primary-fg-color: #E03C33;
--md-primary-fg-color--light: #E03C33;
--md-primary-fg-color--dark: #E03C33;
}

58
mkdocs.yml Normal file
View File

@ -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

1
requirements.txt Normal file
View File

@ -0,0 +1 @@
mkdocs-material~=9.5.15