Skip to content
Documentation Validation

feat: add GitHub Pages with MkDocs documentation #29

Sign in to view logs

feat: add GitHub Pages with MkDocs documentation

feat: add GitHub Pages with MkDocs documentation #29

Workflow file for this run

.github/workflows/docs-validation.yml at adcd1c3
name: Documentation Validation
on:
push:
branches: [main]
paths:
- "docs/**"
- "**/*.md"
pull_request:
branches: [main]
paths:
- "docs/**"
- "**/*.md"
jobs:
validate-mermaid:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install mermaid-cli
run: npm install -g @mermaid-js/mermaid-cli
- name: Validate Mermaid diagrams
run: |
if [ -f scripts/validate-mermaid.sh ]; then
chmod +x scripts/validate-mermaid.sh
./scripts/validate-mermaid.sh
else
echo "No Mermaid diagrams to validate"
fi
env:
PUPPETEER_CONFIG: ${{ github.workspace }}/scripts/puppeteer-config.json
lint-markdown:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Lint Markdown
uses: DavidAnson/markdownlint-cli2-action@v15
with:
globs: "**/*.md"
config: ".markdownlint.json"