Skip to content

Commit

Permalink
docs: migrate docs to MkDocs Material
Browse files Browse the repository at this point in the history
  • Loading branch information
Bionus committed Aug 17, 2023
1 parent 0f774c4 commit 9bb7f2e
Show file tree
Hide file tree
Showing 172 changed files with 1,132 additions and 11,090 deletions.
47 changes: 47 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Docs

on:
push:
branches:
- master
paths:
- mkdocs.yml
- docs/**
- .github/workflows/docs.yml

permissions:
contents: write

jobs:
deploy:
name: Deploy
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v3

- name: Install Python
uses: actions/setup-python@v4
with:
python-version: '3.11'

- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV

- uses: actions/cache@v3
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- name: Install Python dependencies
run: pip install mkdocs-material==9.2.0b3 mkdocs-awesome-pages-plugin mkdocs-macros-plugin mkdocs-git-revision-date-localized-plugin mkdocs-glightbox

- name: Patch blog dates to support datetimes
run: sed -i 's|date.fromisoformat|datetime.fromisoformat|' $(pip show mkdocs-material | grep Location | cut -d ' ' -f 2)/material/plugins/blog/plugin.py

- name: Deploy to Github Pages
run: mkdocs gh-deploy --force
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
6 changes: 0 additions & 6 deletions docs/.gitignore

This file was deleted.

13 changes: 0 additions & 13 deletions docs/Gemfile

This file was deleted.

3 changes: 0 additions & 3 deletions docs/_category/android.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/_category/linux.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/_category/release.md

This file was deleted.

73 changes: 0 additions & 73 deletions docs/_config.yml

This file was deleted.

48 changes: 0 additions & 48 deletions docs/_data/docs_navigation.yml

This file was deleted.

7 changes: 0 additions & 7 deletions docs/_docs/sources.md

This file was deleted.

43 changes: 0 additions & 43 deletions docs/_includes/blog.html

This file was deleted.

30 changes: 0 additions & 30 deletions docs/_includes/body.html

This file was deleted.

27 changes: 0 additions & 27 deletions docs/_includes/navbar_link.html

This file was deleted.

12 changes: 0 additions & 12 deletions docs/_includes/post_preview.html

This file was deleted.

7 changes: 0 additions & 7 deletions docs/_includes/source_list.html

This file was deleted.

6 changes: 0 additions & 6 deletions docs/_layouts/blog.html

This file was deleted.

14 changes: 0 additions & 14 deletions docs/_layouts/blog_category.html

This file was deleted.

Loading

0 comments on commit 9bb7f2e

Please sign in to comment.