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
10 changes: 10 additions & 0 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { defineConfig } from 'vitepress'
import { buildEndGenerateOpenGraphImages } from '@nolebase/vitepress-plugin-og-image/vitepress'

// https://vitepress.dev/reference/site-config
export default defineConfig({
Expand Down Expand Up @@ -52,5 +53,14 @@ export default defineConfig({
{ icon: 'github', link: 'https://github.com/pdmlab/docker-compose' },
{ icon: 'discord', link: 'https://discord.gg/pR6duvNHtV' }
]
},

async buildEnd(siteConfig) {
await buildEndGenerateOpenGraphImages({
baseUrl: 'https://pdmlab.github.io/docker-compose/',
category: {
fallbackWithFrontmatter: true
}
})(siteConfig)
}
})
1 change: 1 addition & 0 deletions docs/api.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
outline: deep
category: Reference
---

# API Docs
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/build.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
category: Commands
---

# build

Build or rebuild services.
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/config.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
category: Commands
---

# config

Validate and view the Compose file configuration.
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/create.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
category: Commands
---

# create

Create containers for services without starting them.
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/down.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
category: Commands
---

# down

Stops containers and removes containers, networks, volumes, and images created by `up`.
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/exec.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
category: Commands
---

# exec

Execute a command in a running container.
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/images.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
category: Commands
---

# images

List images used by the created containers.
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/kill.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
category: Commands
---

# kill

Force stop service containers.
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/logs.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
category: Commands
---

# logs

View output from containers.
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/pause.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
category: Commands
---

# pause / unpause

Pause and unpause services.
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/port.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
category: Commands
---

# port

Print the public port for a port binding.
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/ps.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
category: Commands
---

# ps

Lists containers for a Compose project, with current status and exposed ports.
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/pull.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
category: Commands
---

# pull

Pull service images.
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/push.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
category: Commands
---

# push

Push service images to their registries.
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/restart.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
category: Commands
---

# restart

Restart services.
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/rm.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
category: Commands
---

# rm

Remove stopped service containers.
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/run.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
category: Commands
---

# run

Run a one-off command on a service.
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/stats.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
category: Commands
---

# stats

Display a live stream of container resource usage statistics.
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/stop.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
category: Commands
---

# stop

Stops running containers without removing them.
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/up.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
category: Commands
---

# up

Builds, (re)creates, starts, and attaches to containers for services.
Expand Down
4 changes: 4 additions & 0 deletions docs/commands/version.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
category: Commands
---

# version

Show the Docker Compose version information.
Expand Down
4 changes: 4 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
category: Introduction
---

# Getting started

`docker-compose` is a small library that allows you to run [docker-compose](https://docs.docker.com/compose/) (which is still required) using Node.js. This is useful to bootstrap test environments.
Expand Down
1 change: 1 addition & 0 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"preview": "vitepress preview"
},
"devDependencies": {
"@nolebase/vitepress-plugin-og-image": "^2.18.2",
"vitepress": "^1.6.4"
}
}
22 changes: 22 additions & 0 deletions docs/public/og-template.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading