Skip to content

Commit ff4792a

Browse files
committed
docs: prepare github pages for better documentation
1 parent 4c3f8d2 commit ff4792a

File tree

3 files changed

+66
-0
lines changed

3 files changed

+66
-0
lines changed

.github/workflows/pages.yml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Pages
2+
on:
3+
push:
4+
paths:
5+
- 'docs/**.md'
6+
- 'mkdocs.yml'
7+
- '.github/workflows/pages.yml'
8+
branches: [ main ]
9+
permissions:
10+
contents: write
11+
jobs:
12+
deploy:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
16+
- name: Configure Git Credentials
17+
run: |
18+
git config user.name github-actions[bot]
19+
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
20+
- uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5
21+
with:
22+
python-version: 3.13
23+
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
24+
- uses: actions/cache@0c907a75c2c80ebcb7f088228285e798b750cf8f # v4
25+
with:
26+
key: mkdocs-material-${{ env.cache_id }}
27+
path: .cache
28+
restore-keys: |
29+
mkdocs-material-
30+
- run: pip install mkdocs-material
31+
- run: mkdocs gh-deploy --force

docs/index.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Welcome to the GeoServer Dockerfile documentation
2+
3+
This is just a placeholder for future documentation.

mkdocs.yml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
site_name: GeoServer Dockerfile Documentation
2+
repo_url: https://github.com/geoserver/docker
3+
nav:
4+
- Home: index.md
5+
theme:
6+
name: material
7+
language: en
8+
icon:
9+
logo: material/library-outline
10+
font:
11+
text: Roboto
12+
features:
13+
- content.tooltips
14+
- content.code.copy
15+
palette:
16+
# Palette toggle for dark mode
17+
- media: "(prefers-color-scheme: dark)"
18+
scheme: slate
19+
primary: black
20+
accent: indigo
21+
toggle:
22+
icon: material/weather-night
23+
name: Switch to light mode
24+
# Palette toggle for light mode
25+
- media: "(prefers-color-scheme: light)"
26+
27+
scheme: default
28+
primary: black
29+
accent: indigo
30+
toggle:
31+
icon: material/weather-sunny
32+
name: Switch to dark mode

0 commit comments

Comments
 (0)