Skip to content

Commit

Permalink
docs: use Zola for static docs
Browse files Browse the repository at this point in the history
https://www.getzola.org/

For local development use: `just docs`
  • Loading branch information
alecthomas committed Jun 8, 2024
1 parent 73c2f3f commit e985541
Show file tree
Hide file tree
Showing 32 changed files with 939 additions and 324 deletions.
9 changes: 9 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,15 @@ jobs:
run: just init-db
- name: Rebuild All
run: just build-all
docs:
name: Build Docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
submodules: true
- uses: cashapp/activate-hermit@v1
- run: cd docs && zola build
integration-shard:
name: Shard Integration Tests
runs-on: ubuntu-latest
Expand Down
22 changes: 22 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
on:
push:
branches:
- main
name: Publish Docs
jobs:
build:
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/main'
steps:
- name: checkout
uses: actions/checkout@v4
with:
submodules: true
- name: build_and_deploy
uses: shalzz/[email protected]
env:
# Target branch
PAGES_BRANCH: gh-pages
# Or if publishing to the same repo, use the automatic token
TOKEN: ${{ secrets.GITHUB_TOKEN }}
BUILD_DIR: docs
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,4 @@ go.work*
junit*.xml
/readme-tests
**/_ftl
/docs/public
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "docs/themes/adidoks"]
path = docs/themes/adidoks
url = https://github.com/aaranxu/adidoks.git
5 changes: 5 additions & 0 deletions Justfile
Original file line number Diff line number Diff line change
Expand Up @@ -135,3 +135,8 @@ lint-frontend: build-frontend
# Lint the backend
lint-backend:
@golangci-lint run ./...

# Run live docs server
docs:
git submodule update --init --recursive
cd docs && zola serve
1 change: 1 addition & 0 deletions bin/.zola-0.18.0.pkg
1 change: 1 addition & 0 deletions bin/zola
324 changes: 0 additions & 324 deletions docs/README.md

This file was deleted.

Loading

0 comments on commit e985541

Please sign in to comment.