diff options
| author | Kent Daleng <lolexplode@gmail.com> | 2025-08-17 16:05:41 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-08-17 17:05:41 +0300 |
| commit | dc93f1c1fd7b67e2da5af2ffada732b9ddeb2d6a (patch) | |
| tree | a2f2938a7df17c196be7016dc5fe1fc9f75fb484 /.github | |
| parent | a6febb86aa5af0df7bf2792ca027ef95a503d599 (diff) | |
| download | niri-dc93f1c1fd7b67e2da5af2ffada732b9ddeb2d6a.tar.gz niri-dc93f1c1fd7b67e2da5af2ffada732b9ddeb2d6a.tar.bz2 niri-dc93f1c1fd7b67e2da5af2ffada732b9ddeb2d6a.zip | |
github wiki replacement / mkdocs-docs (#2147)
* Add wiki based on mkdocs
* wording fixes
* fix github bg color on narrow
* Fix left sidebar section headers being bigger than pages
* fix hover accent
* fix list rendering on fractional layout
* fix videos
* fix automatic full links
* remove redundant commented css
* improve dark mode contrast
* update pygments for better child node coloring
* update logo
* remove blank lines
* add systemd language hint
---------
Co-authored-by: Ivan Molodetskikh <yalterz@gmail.com>
Diffstat (limited to '.github')
| -rw-r--r-- | .github/workflows/ci.yml | 48 |
1 files changed, 24 insertions, 24 deletions
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 93713dff..ff10b677 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -291,21 +291,10 @@ jobs: - run: nix flake check continue-on-error: true - check-links: - runs-on: ubuntu-24.04 - steps: - - uses: actions/checkout@v4 - with: - show-progress: false - - uses: lycheeverse/lychee-action@v2.0.2 # later versions break fragment checks. don't bump until this is fixed: https://github.com/lycheeverse/lychee/issues/1574 - with: - args: --offline --include-fragments 'wiki/*.md' - publish-wiki: if: github.event_name == 'push' && github.ref == 'refs/heads/main' needs: - - build - - check-links + - publish-docs permissions: contents: write runs-on: ubuntu-24.04 @@ -315,28 +304,39 @@ jobs: lfs: true show-progress: false - uses: Andrew-Chen-Wang/github-wiki-action@b7e552d7cb0fa7f83e459012ffc6840fd87bcb83 + with: + path: docs/wiki/ - rustdoc: - needs: build - permissions: - contents: write + publish-docs: + if: github.event_name == 'push' && github.ref == 'refs/heads/main' + needs: + - build runs-on: ubuntu-24.04 steps: - uses: actions/checkout@v4 with: + lfs: true show-progress: false - + - name: Install uv + uses: astral-sh/setup-uv@v6 + with: + enable-cache: true + - name: Install the project + run: uv sync --locked --all-extras --dev + working-directory: docs/ + - name: Generate niri documentation + run: uv run mkdocs build + working-directory: docs/ - uses: dtolnay/rust-toolchain@stable - - - name: Generate documentation + - name: Generate rustdoc documentation run: cargo doc --no-deps -p niri-ipc - - - run: cp ./resources/rustdoc-index.html ./target/doc/index.html - + - run: mkdir -p publish/niri_ipc + - run: cp -r ./target/doc/* ./publish/ + - run: cp -r ./docs/site/* ./publish/ - name: Deploy documentation if: github.ref == 'refs/heads/main' uses: peaceiris/actions-gh-pages@v4 with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./target/doc - force_orphan: true + publish_dir: ./publish + force_orphan: true
\ No newline at end of file |