mirror of
https://github.com/alfishe/amiga-bootcamp.git
synced 2026-09-11 10:46:28 +00:00
Initial Setup for Properdocs
This commit is contained in:
parent
c6f6253ea0
commit
610c4a0fe4
3 changed files with 53 additions and 0 deletions
41
.github/workflows/web.yml
vendored
Normal file
41
.github/workflows/web.yml
vendored
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
name: ci
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
- main
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
pages: write
|
||||
|
||||
jobs:
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Configure Git Credentials
|
||||
run: |
|
||||
git config user.name github-actions[bot]
|
||||
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
|
||||
|
||||
- uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: 3.x
|
||||
|
||||
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
|
||||
|
||||
- uses: actions/cache@v4
|
||||
with:
|
||||
key: mkdocs-material-${{ env.cache_id }}
|
||||
path: .cache
|
||||
restore-keys: |
|
||||
mkdocs-material-
|
||||
|
||||
- name: Install dependencies
|
||||
run: pip install -r requirements.txt properdocs
|
||||
|
||||
- name: Deploy to GitHub Pages
|
||||
run: properdocs gh-deploy --config-file properdocs.yml --force
|
||||
9
properdocs.yml
Normal file
9
properdocs.yml
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
site_name: Amiga OS 3.1/3.2 - Developer Source of Truth
|
||||
|
||||
# CRITICAL: Tells ProperDocs that Markdown files live at root level
|
||||
docs_dir: .
|
||||
|
||||
theme: materialx
|
||||
|
||||
plugins:
|
||||
- same-dir
|
||||
3
requirements.txt
Normal file
3
requirements.txt
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
properdocs
|
||||
mkdocs-materialx
|
||||
mkdocs-same-dir
|
||||
Loading…
Add table
Add a link
Reference in a new issue