From e27761384db9f707cbb49eac55acc616c5a0eb31 Mon Sep 17 00:00:00 2001 From: michalsn Date: Sat, 11 Apr 2026 17:33:19 +0200 Subject: [PATCH 1/2] set up versioned docs with mike --- .github/workflows/docs.yml | 31 ++++++++++++++++++++++++++++--- mkdocs.yml | 7 +++++++ requirements-docs.txt | 2 ++ 3 files changed, 37 insertions(+), 3 deletions(-) create mode 100644 requirements-docs.txt diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 0d65129..3777f84 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -4,9 +4,13 @@ on: push: branches: - develop + - v2 paths: - - 'docs/*' + - 'docs/**' - 'mkdocs.yml' + - 'requirements-docs.txt' + - '.github/workflows/docs.yml' + workflow_dispatch: permissions: contents: write @@ -16,8 +20,29 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v6 + with: + fetch-depth: 0 - uses: actions/setup-python@v6 with: python-version: 3.x - - run: pip install mkdocs-material - - run: mkdocs gh-deploy --force + - run: pip install -r requirements-docs.txt + - run: git fetch origin gh-pages --depth=1 + - run: git config user.name github-actions[bot] + - run: git config user.email 41898282+github-actions[bot]@users.noreply.github.com + - name: Deploy docs with mike + env: + BRANCH_NAME: ${{ github.ref_name }} + run: | + case "$BRANCH_NAME" in + develop) + mike deploy --push --update-aliases dev + ;; + v2) + mike deploy --push --update-aliases v2 latest + mike set-default --push latest + ;; + *) + echo "Unsupported docs branch: $BRANCH_NAME" + exit 1 + ;; + esac diff --git a/mkdocs.yml b/mkdocs.yml index 46d8fe8..b9fb6bf 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,6 @@ site_name: CodeIgniter HTMX site_description: Documentation for HTMX helper library for CodeIgniter 4 framework +site_url: https://michalsn.github.io/codeigniter-htmx/ theme: name: material @@ -25,6 +26,8 @@ theme: extra: homepage: https://michalsn.github.io/codeigniter-htmx + version: + provider: mike social: - icon: fontawesome/brands/github @@ -39,6 +42,10 @@ markdown_extensions: - pymdownx.highlight: use_pygments: false +plugins: + - search + - mike + extra_css: - assets/github-dark-dimmed.css diff --git a/requirements-docs.txt b/requirements-docs.txt new file mode 100644 index 0000000..04ebb9b --- /dev/null +++ b/requirements-docs.txt @@ -0,0 +1,2 @@ +mkdocs-material +mike From d6c300fcff64209a5067dce2926e9b50a7e5800c Mon Sep 17 00:00:00 2001 From: michalsn Date: Sat, 11 Apr 2026 17:51:00 +0200 Subject: [PATCH 2/2] make develop the latest docs version --- .github/workflows/docs.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 3777f84..8410e74 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -35,11 +35,11 @@ jobs: run: | case "$BRANCH_NAME" in develop) - mike deploy --push --update-aliases dev + mike deploy --push --update-aliases dev latest + mike set-default --push latest ;; v2) - mike deploy --push --update-aliases v2 latest - mike set-default --push latest + mike deploy --push --update-aliases v2 ;; *) echo "Unsupported docs branch: $BRANCH_NAME"