mirror of
https://github.com/maplibre/martin.git
synced 2024-12-19 04:41:46 +03:00
45 lines
1.2 KiB
YAML
45 lines
1.2 KiB
YAML
name: Documentation
|
|
|
|
on:
|
|
push:
|
|
branches: [ main ]
|
|
pull_request:
|
|
|
|
jobs:
|
|
build-docs:
|
|
name: Build Docs
|
|
runs-on: ubuntu-latest
|
|
concurrency:
|
|
group: ${{ github.workflow }}-${{ github.ref }}
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: Swatinem/rust-cache@v2
|
|
|
|
- name: 'Validate .md files (use "just fmt-md" to fix)'
|
|
uses: DavidAnson/markdownlint-cli2-action@v16
|
|
with:
|
|
config: '.github/files/config.markdownlint-cli2.jsonc'
|
|
|
|
- name: 'Check Markdown URLs (same as "just clippy-md")'
|
|
uses: gaurav-nelson/github-action-markdown-link-check@v1
|
|
with:
|
|
use-quiet-mode: 'no'
|
|
use-verbose-mode: 'yes'
|
|
folder-path: 'docs/src'
|
|
file-path: './README.md'
|
|
config-file: '.github/files/markdown.links.config.json'
|
|
|
|
- name: Setup mdBook
|
|
uses: peaceiris/actions-mdbook@v2
|
|
with:
|
|
mdbook-version: '0.4.40'
|
|
|
|
- run: mdbook build docs
|
|
|
|
- name: Deploy
|
|
uses: peaceiris/actions-gh-pages@v4
|
|
if: github.ref == 'refs/heads/main'
|
|
with:
|
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
publish_dir: ./target/book
|