5bee5c0aa0
- Created comprehensive MkDocs configuration with Material theme - Set up organized documentation structure for ALwrity features - Added GitHub Pages deployment workflow - Created initial documentation pages: - Homepage with feature overview - Quick Start guide - Blog Writer and SEO Dashboard feature docs - Comprehensive troubleshooting guide - Configured responsive design with dark/light mode toggle - Added search functionality and navigation - Set up automatic deployment to GitHub Pages The documentation site will be available at https://alwrity.github.io/ALwrity
63 lines
1.3 KiB
YAML
63 lines
1.3 KiB
YAML
name: Deploy Documentation
|
|
|
|
on:
|
|
push:
|
|
branches: [main]
|
|
paths: ['docs/**', 'docs-site/**', 'mkdocs.yml']
|
|
pull_request:
|
|
branches: [main]
|
|
paths: ['docs/**', 'docs-site/**', 'mkdocs.yml']
|
|
|
|
permissions:
|
|
contents: read
|
|
pages: write
|
|
id-token: write
|
|
|
|
concurrency:
|
|
group: "pages"
|
|
cancel-in-progress: false
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- name: Setup Python
|
|
uses: actions/setup-python@v4
|
|
with:
|
|
python-version: '3.10'
|
|
|
|
- name: Install dependencies
|
|
run: |
|
|
python -m pip install --upgrade pip
|
|
pip install mkdocs mkdocs-material
|
|
|
|
- name: Setup Pages
|
|
uses: actions/configure-pages@v4
|
|
|
|
- name: Build documentation
|
|
run: |
|
|
cd docs-site
|
|
mkdocs build
|
|
|
|
- name: Upload artifact
|
|
uses: actions/upload-pages-artifact@v3
|
|
with:
|
|
path: docs-site/site
|
|
|
|
deploy:
|
|
environment:
|
|
name: github-pages
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
|
runs-on: ubuntu-latest
|
|
needs: build
|
|
if: github.ref == 'refs/heads/main'
|
|
steps:
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@v4
|