Skip to content

Commit 5527c71

Browse files
fix(ci): markdown docs formatting (#2582)
Minor cleanups from the docs update PR I missed --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 0a8c4a1 commit 5527c71

File tree

7 files changed

+32
-35
lines changed

7 files changed

+32
-35
lines changed

.github/workflows/build-deploy-docs.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,6 @@ jobs:
3434
file-path: './README.md'
3535
config-file: '.github/files/markdown.links.config.json'
3636

37-
- name: Install Chromium
38-
uses: browser-actions/setup-chrome@4f8e94349a351df0f048634f25fec36c3c91eded # v2.1.1
3937
- uses: taiki-e/install-action@69e777b377e4ec209ddad9426ae3e0c1008b0ef3 # v2.64.0
4038
with: { tool: 'just,cargo-binstall' }
4139

.pre-commit-config.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ repos:
5656
VERSION=$(grep "^version = " martin/Cargo.toml | sed "s/version = \"\(.*\)\"/\1/")
5757
sed -i "s/version\": \".*\"/version\": \"$VERSION\"/" martin/martin-ui/package.json
5858
sed -i "s%ghcr.io/maplibre/martin:[^[:space:]]*%ghcr.io/maplibre/martin:$VERSION%" docs/content/run-with-docker-compose.md
59+
sed -i "s%ghcr.io/maplibre/martin:[^[:space:]]*%ghcr.io/maplibre/martin:$VERSION%" docs/content/run-with-nginx.md
5960
sed -i "s%ghcr.io/maplibre/martin:[^[:space:]]*%ghcr.io/maplibre/martin:$VERSION%" docs/content/run-with-docker.md
6061
sed -i "s%ghcr.io/maplibre/martin:[^[:space:]]* %ghcr.io/maplibre/martin:$VERSION %" docs/content/installation.md
6162
sed -i "s%ghcr.io/maplibre/martin:[^[:space:]]* %ghcr.io/maplibre/martin:$VERSION %" docs/content/run-with-lambda.md

docs/content/config-file/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,5 @@ martin ... ... ... --save-config config.yaml
2020
## Config Example
2121

2222
```yaml
23-
--8<-- "config.yaml"
23+
--8<-- "files/config.yaml"
2424
```
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
services:
2+
nginx:
3+
image: nginx:alpine
4+
restart: unless-stopped
5+
ports:
6+
- "80:80"
7+
volumes:
8+
- ./cache:/var/cache/nginx
9+
- ./nginx.conf:/etc/nginx/nginx.conf:ro
10+
depends_on:
11+
- martin
12+
13+
martin:
14+
image: ghcr.io/maplibre/martin:1.3.1
15+
restart: unless-stopped
16+
environment:
17+
- DATABASE_URL=postgres://postgres:password@db/db
18+
depends_on:
19+
- db
20+
21+
db:
22+
image: postgis/postgis:18-3.6
23+
restart: unless-stopped
24+
environment:
25+
- POSTGRES_DB=db
26+
- POSTGRES_USER=postgres
27+
- POSTGRES_PASSWORD=password
28+
volumes:
29+
- ./pg_data:/var/lib/postgresql/data

docs/content/run-with-nginx.md

Lines changed: 1 addition & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,7 @@ You can run Martin behind NGINX proxy, so you can cache frequently accessed tile
44
Here is an example `docker-compose.yml` file that runs Martin with NGINX and PostgreSQL.
55

66
```yml
7-
version: '3'
8-
9-
services:
10-
nginx:
11-
image: nginx:alpine
12-
restart: unless-stopped
13-
ports:
14-
- "80:80"
15-
volumes:
16-
- ./cache:/var/cache/nginx
17-
- ./nginx.conf:/etc/nginx/nginx.conf:ro
18-
depends_on:
19-
- martin
20-
21-
martin:
22-
image: maplibre/martin:v0.7.0
23-
restart: unless-stopped
24-
environment:
25-
- DATABASE_URL=postgres://postgres:password@db/db
26-
depends_on:
27-
- db
28-
29-
db:
30-
image: postgis/postgis:14-3.3-alpine
31-
restart: unless-stopped
32-
environment:
33-
- POSTGRES_DB=db
34-
- POSTGRES_USER=postgres
35-
- POSTGRES_PASSWORD=password
36-
volumes:
37-
- ./pg_data:/var/lib/postgresql/data
7+
--8<-- "files/compose.nginx.yaml"
388
```
399

4010
You can [find an example NGINX configuration file here](https://github.com/maplibre/martin/blob/main/demo/frontend/nginx.conf).

docs/content/sources-styles.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ A restart of Martin is required to see new styles.
2525
This feature is currently unstable and thus not included in the default build.
2626
Its behaviour may change in patch releases.
2727

28-
2928
To experiment with it, [install Rust](https://rust-lang.org/tools/install/) and run `just install-dependencies`.
3029
With these installed, run the following command to install martin with the unstable feature:
3130

0 commit comments

Comments
 (0)