feat: add mkdocs

Signed-off-by: kjuulh <contact@kjuulh.io>
This commit is contained in:
Kasper Juul Hermansen 2023-07-28 22:07:07 +02:00
parent 55ae63599d
commit 3f0d171285
Signed by: kjuulh
GPG Key ID: 9AA7BC13CE474394
6 changed files with 84 additions and 0 deletions

29
README.md Normal file
View File

@ -0,0 +1,29 @@
# Cuddle Please
Cuddle Please is an extension to `cuddle`, it is a separate binary that can be executed standalone as cuddle-please, or in cuddle as `cuddle please`.
The goal of the software is to be a `release-please` clone, targeting `gitea` instead of `github`.
The tool can be executed as a binary using:
`cuddle please pr create`
And when a release has been built:
```bash
cuddle please release
```
cuddle will default to information to it available in git, or use a specific entry in `cuddle.yaml` called
```yaml
# ...
please:
name: <something>
# ...
# ...
```
or as `cuddle.please.yaml`
See docs for more information about installation and some such

View File

@ -5,4 +5,11 @@ base: "git@git.front.kjuulh.io:kjuulh/cuddle-base.git"
vars: vars:
service: "cuddle-release" service: "cuddle-release"
registry: kasperhermansen registry: kasperhermansen
mkdocs_image: "squidfunk/mkdocs-material:9.1"
scripts:
"mkdocs:new":
type: shell
"mkdocs:dev":
type: shell

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.

21
mkdocs.yml Normal file
View File

@ -0,0 +1,21 @@
site_name: cuddle-please
theme:
name: material
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: deep-orange
accent: deep orange
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: deep orange
accent: deep orange
toggle:
icon: material/brightness-4
name: Switch to light mode # Palette toggle for light mode

5
scripts/mkdocs:dev.sh Executable file
View File

@ -0,0 +1,5 @@
#!/usr/bin/env bash
set -e
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs ${MKDOCS_IMAGE}

5
scripts/mkdocs:new.sh Executable file
View File

@ -0,0 +1,5 @@
#!/usr/bin/env bash
set -e
docker run --rm -it -v ${PWD}:/docs ${MKDOCS_IMAGE} new .