mirrors/dozzle
1
0
Fork 0
mirror of https://github.com/amir20/dozzle.git synced 2025-12-24 06:28:42 +01:00
Code Issues Projects Releases Wiki Activity

docs: removes custom content link in docs

Browse Source
This commit is contained in:
Amir Raminfar
2023-12-30 18:53:00 -08:00
parent 98bf45c5bc
commit 4bd66601cb
2 changed files with 0 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/.vitepress/config.ts
View File

@@ -69,7 +69,6 @@ export default defineConfig({
{ text: "Hostname", link: "/guide/hostname" },
{ text: "Remote Hosts", link: "/guide/remote-hosts" },
{ text: "Container Actions", link: "/guide/actions" },
{ text: "Custom Documentation", link: "/guide/custom-documentation" },
{ text: "Supported Env Vars", link: "/guide/supported-env-vars" },
{ text: "Logging Files on Disk", link: "/guide/log-files-on-disk" },
{ text: "Analytics", link: "/guide/analytics" },

56
docs/guide/custom-documentation.md
View File

@@ -1,56 +0,0 @@
---
title: Customizing Help Content
---
# Documentation and Content
::: tip Note
This feature was introduced in version `v5.1.x`
:::
Dozzle can be used by many users from different levels. Some teams what a central place to explain how to use Dozzle and what each of their containers do. Dozzle supports markdown content by reading `/data/content/*.md` files. Multiple files are supported. Each file will create a link at the top of Dozzle. Here is an example of what `/data/content/help.md` might look like:
```yml
---
title: Help
---
# This is help
Hello, from Dozzle.
Tables are also supported!
| foo | bar |
| --- | --- |
| baz | bim |
```
`title` is used to show a link on Dozzle's home screen to `/content/help`. Dozzle will need `/data` mounted. Here is an example:
::: code-group
```sh [cli]
$ docker run -v /var/run/docker.sock:/var/run/docker.sock -v /path/to/dozzle/data:/data -p 8080:8080 amir20/dozzle
```
```yaml [docker-compose.yml]
version: "3"
services:
dozzle:
image: amir20/dozzle:latest
volumes:
- /var/run/docker.sock:/var/run/docker.sock
- /path/to/dozzle/data:/data
ports:
- 8080:8080
```
```yml [help.md]
---
title: Help
---
# This is help
Hello, from Dozzle.
```
:::