docs: update MkDocs configuration and documentation structure

- Refactor mkdocs.yml with new project name and simplified configuration
- Update GitHub Actions workflow to use MkDocs Material deployment
- Add new configuration files for Claude Desktop
- Reorganize documentation navigation and structure
- Update CSS and JavaScript references
This commit is contained in:
jango-blockchained
2025-02-05 12:44:26 +01:00
parent 3e7f3920b2
commit 13a27e1d00
5 changed files with 41 additions and 101 deletions

View File

@@ -1,64 +1,25 @@
name: Deploy Documentation to GitHub Pages
name: Deploy MkDocs
on:
push:
branches:
- main
paths:
- 'docs/**'
- '.github/workflows/deploy-docs.yml'
- main # or master, depending on your default branch
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
contents: write
jobs:
build:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Ruby
uses: ruby/setup-ruby@v1
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
ruby-version: '3.2'
bundler-cache: true
cache-version: 0
- name: Setup Pages
uses: actions/configure-pages@v4
python-version: '3.x'
- name: Install dependencies
run: |
cd docs
bundle install
- name: Build site
run: |
cd docs
bundle exec jekyll build
env:
JEKYLL_ENV: production
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/_site
deploy:
needs: build
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
pip install mkdocs-material
pip install mkdocs-git-revision-date-localized-plugin
pip install mkdocstrings[python]
- name: Deploy
run: mkdocs gh-deploy --force