From ed882463f42251eadbafe424244b3d4663992b0f Mon Sep 17 00:00:00 2001 From: kjuulh Date: Wed, 25 Sep 2024 21:11:19 +0200 Subject: [PATCH] feat: add basic mkdocs site --- .gitignore | 1 + README.md | 2 +- cuddle.yaml | 11 ++++++++++ docs/blog/index.md | 1 + docs/blog/posts/.authors.yml | 7 +++++++ docs/blog/posts/.meta.yml | 2 ++ docs/blog/posts/intro.md | 16 +++++++++++++++ docs/index.md | 1 + docs/scratchpad.md | 1 + mkdocs.yml | 39 ++++++++++++++++++++++++++++++++++++ renovate.json | 3 +++ scripts/dev.sh | 7 +++++++ templates/Dockerfile | 3 +++ templates/docker-compose.yml | 10 +++++++++ 14 files changed, 103 insertions(+), 1 deletion(-) create mode 100644 .gitignore create mode 100644 cuddle.yaml create mode 100644 docs/blog/index.md create mode 100644 docs/blog/posts/.authors.yml create mode 100644 docs/blog/posts/.meta.yml create mode 100644 docs/blog/posts/intro.md create mode 100644 docs/index.md create mode 100644 docs/scratchpad.md create mode 100644 mkdocs.yml create mode 100644 renovate.json create mode 100755 scripts/dev.sh create mode 100644 templates/Dockerfile create mode 100644 templates/docker-compose.yml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..75d1871 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.cuddle/ diff --git a/README.md b/README.md index edf8c89..777e287 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# No Workshop Scripts +# no-workshop-scripts This repository contains all video scripts for the nonothing channel diff --git a/cuddle.yaml b/cuddle.yaml new file mode 100644 index 0000000..943e9bb --- /dev/null +++ b/cuddle.yaml @@ -0,0 +1,11 @@ +# yaml-language-server: $schema=https://git.front.kjuulh.io/kjuulh/cuddle/raw/branch/main/schemas/base.json + +base: "git@git.front.kjuulh.io:kjuulh/cuddle-empty-plan.git" + +vars: + service: "no-workshop-scripts" + registry: kasperhermansen + +scripts: + dev: + type: shell diff --git a/docs/blog/index.md b/docs/blog/index.md new file mode 100644 index 0000000..458b3cc --- /dev/null +++ b/docs/blog/index.md @@ -0,0 +1 @@ +# scripts diff --git a/docs/blog/posts/.authors.yml b/docs/blog/posts/.authors.yml new file mode 100644 index 0000000..cd9da2f --- /dev/null +++ b/docs/blog/posts/.authors.yml @@ -0,0 +1,7 @@ +authors: + kjuulh: + name: "kjuulh" # Author name + description: "No/Nothing" # Author description + avatar: https://git.front.kjuulh.io/avatars/260eef75e2c53962646a315683a1d1e5?size=512 + # slug: url # Author profile slug + # url: url # Author website URL diff --git a/docs/blog/posts/.meta.yml b/docs/blog/posts/.meta.yml new file mode 100644 index 0000000..d549b11 --- /dev/null +++ b/docs/blog/posts/.meta.yml @@ -0,0 +1,2 @@ +authors: + kjuulh diff --git a/docs/blog/posts/intro.md b/docs/blog/posts/intro.md new file mode 100644 index 0000000..76af2f8 --- /dev/null +++ b/docs/blog/posts/intro.md @@ -0,0 +1,16 @@ +--- +date: 2024-08-25 +authors: + - kjuulh +draft: false +#categories: +# - Hello +# - World +#tags: +# - Foo +# - Bar +--- + +# Introduction + +Le Kasper diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..de934ed --- /dev/null +++ b/docs/index.md @@ -0,0 +1 @@ +# no/nothing scripts diff --git a/docs/scratchpad.md b/docs/scratchpad.md new file mode 100644 index 0000000..b1d6939 --- /dev/null +++ b/docs/scratchpad.md @@ -0,0 +1 @@ +# scratch-pad diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..d925acc --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,39 @@ +site_name: no/nothing +repo_url: https://github.com/nogitplease/no-workshop-scripts + +plugins: + - blog: + authors: true + authors_file: "{blog}/posts/.authors.yml" + blog_toc: true + - search: + +nav: + - index.md + - scratchpad.md + - Blog: + - blog/index.md + +theme: + name: material + palette: + + # Palette toggle for automatic mode + - media: "(prefers-color-scheme)" + toggle: + icon: material/brightness-auto + name: Switch to light mode + + # Palette toggle for light mode + - media: "(prefers-color-scheme: light)" + scheme: default + toggle: + icon: material/brightness-7 + name: Switch to dark mode + + # Palette toggle for dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + toggle: + icon: material/brightness-4 + name: Switch to system preference diff --git a/renovate.json b/renovate.json new file mode 100644 index 0000000..7190a60 --- /dev/null +++ b/renovate.json @@ -0,0 +1,3 @@ +{ + "$schema": "https://docs.renovatebot.com/renovate-schema.json" +} diff --git a/scripts/dev.sh b/scripts/dev.sh new file mode 100755 index 0000000..cd32c57 --- /dev/null +++ b/scripts/dev.sh @@ -0,0 +1,7 @@ +#!/usr/bin/env zsh + +set -e + +echo "$PWD" + +docker compose -f templates/docker-compose.yml up --build diff --git a/templates/Dockerfile b/templates/Dockerfile new file mode 100644 index 0000000..564d15a --- /dev/null +++ b/templates/Dockerfile @@ -0,0 +1,3 @@ +FROM squidfunk/mkdocs-material:9.5 + +#RUN pip install diff --git a/templates/docker-compose.yml b/templates/docker-compose.yml new file mode 100644 index 0000000..047a866 --- /dev/null +++ b/templates/docker-compose.yml @@ -0,0 +1,10 @@ +services: + mkdocs: + build: + context: ../ + dockerfile: ./templates/Dockerfile + ports: + - "8000:8000" + volumes: + - ${PWD}:/docs + command: serve -a 0.0.0.0:8000