Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/workflows/build-deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,9 @@ jobs:
- name: Setup mdBook
uses: peaceiris/actions-mdbook@v2
with:
mdbook-version: '0.4.40'
mdbook-version: '0.4.51'
- name: Install mdbook-alerts
run: cargo install mdbook-alerts
Comment on lines 32 to +37
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- name: Setup mdBook
uses: peaceiris/actions-mdbook@v2
with:
mdbook-version: '0.4.40'
mdbook-version: '0.4.51'
- name: Install mdbook-alerts
run: cargo install mdbook-alerts
- uses: taiki-e/install-action@v2
with: { tool: mdbook }
- name: Install mdbook-alerts
run: cargo binstall mdbook-alerts


- run: mdbook build docs

Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The documentation of `maplibre/martin` is available at <https://maplibre.org/mar
To build/develop this documentation locally, you can install `mdbook` and `mdbook-linkcheck`.

```bash
cargo install mdbook
cargo install mdbook mdbook-alerts
```

## Development
Expand Down
2 changes: 2 additions & 0 deletions docs/book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,5 @@ build-dir = "../target/book"
curly-quotes = true
git-repository-url = "https://github.com/maplibre/martin"
edit-url-template = "https://github.com/maplibre/martin/edit/main/docs/{path}"

[preprocessor.alerts]
5 changes: 4 additions & 1 deletion docs/src/using-with-renderer.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Map renderer specific

Martin is mostly a general purpose tileserver.
The exception is style serving, as it is specific to [maplibre](https://maplibre.org).
It can thus be used in conjunction with renderers that are not [maplibre](https://maplibre.org).

> [!WARNING]
> Style serving, as it is specific to [maplibre](https://maplibre.org).
2 changes: 1 addition & 1 deletion justfile
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ bless-int:
rm -rf tests/expected && mv tests/output tests/expected

# Build and open mdbook documentation
book: (cargo-install 'mdbook')
book: (cargo-install 'mdbook') (cargo-install 'mdbook-alerts')
mdbook serve docs --open --port 8321

# Quick compile without building a binary
Expand Down
Loading