Skip to content

Commit f35305a

Browse files
committed
docs: add custom OG template and category frontmatter
- Add custom SVG template without third-party branding - Add category frontmatter to all documentation pages
1 parent f25e7b1 commit f35305a

File tree

24 files changed

+107
-1
lines changed

24 files changed

+107
-1
lines changed

docs/.vitepress/config.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,6 @@ export default defineConfig({
5959
await buildEndGenerateOpenGraphImages({
6060
baseUrl: 'https://pdmlab.github.io/docker-compose/',
6161
category: {
62-
byLevel: 2,
6362
fallbackWithFrontmatter: true
6463
}
6564
})(siteConfig)

docs/api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
outline: deep
3+
category: Reference
34
---
45

56
# API Docs

docs/commands/build.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
category: Commands
3+
---
4+
15
# build
26

37
Build or rebuild services.

docs/commands/config.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
category: Commands
3+
---
4+
15
# config
26

37
Validate and view the Compose file configuration.

docs/commands/create.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
category: Commands
3+
---
4+
15
# create
26

37
Create containers for services without starting them.

docs/commands/down.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
category: Commands
3+
---
4+
15
# down
26

37
Stops containers and removes containers, networks, volumes, and images created by `up`.

docs/commands/exec.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
category: Commands
3+
---
4+
15
# exec
26

37
Execute a command in a running container.

docs/commands/images.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
category: Commands
3+
---
4+
15
# images
26

37
List images used by the created containers.

docs/commands/kill.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
category: Commands
3+
---
4+
15
# kill
26

37
Force stop service containers.

docs/commands/logs.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
category: Commands
3+
---
4+
15
# logs
26

37
View output from containers.

0 commit comments

Comments
 (0)