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: 4 additions & 0 deletions .github/actions/spelling/expect.txt
Original file line number Diff line number Diff line change
Expand Up @@ -605,6 +605,7 @@ pidof
pids
Piljk
pki
plantuml
popafter
postconf
postfixadmin
Expand All @@ -631,6 +632,7 @@ proctitle
proofpoint
proxymap
pubout
puml
putscript
pvo
pwcheck
Expand Down Expand Up @@ -825,6 +827,7 @@ toolarge
transitioning
Troost
tscript
tsvg
TTLs
tuxfamily
typedef
Expand All @@ -838,6 +841,7 @@ UIDPLUS
uids
uidv
uidvalidity
UML
unaccessed
unaliased
unauth
Expand Down
30 changes: 30 additions & 0 deletions assets/plantuml/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# PlantUML Data

This directory contains PlantUML files that are used to create diagrams for
the documentation.

## Docker

[PlantUML](https://plantuml.com/) files are converted to SVG by using a Java
program.

It is easiest to run the program by using a pre-configured Docker container.

The output command is as follows:

```
docker run --rm -v /path/to/your/puml/files:/data \
-v /path/to/your/output/directory:/output plantuml/plantuml \
-tsvg /data/your_diagram.puml \
-o /output
```

For example, if running from this directory to convert foo.puml, and storing
the SVG file in the "docs/core/images" directory (so it can be referenced via
Markdown from within VitePress), run:

```
mkdir -p ../../docs/core/images
docker run --rm -v ./:/data -v ../../docs/core/images:/output \
plantuml/plantuml -tsvg /data/foo.puml -o /output
```
1 change: 1 addition & 0 deletions docs/core/config/images/submission_flow.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/core/config/submission.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ service:

## Flow Diagram

<!-- @include: @docs/core/config/include/submission_flow.inc -->
![Submission Flow Diagram](/docs/core/config/images/submission_flow.svg)

## Configuration

Expand Down
2 changes: 0 additions & 2 deletions lib/markdown.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import containerPlugin from 'markdown-it-container'
import fg from 'fast-glob'
import deflistPlugin from 'markdown-it-deflist'
import { plantuml } from "@mdit/plugin-plantuml";
import path from 'path'
import { createMarkdownRenderer } from 'vitepress'
import { dovecotSetting, frontmatterIter, loadData } from './utility.js'
Expand All @@ -18,7 +17,6 @@ export function dovecotMdExtend(md) {
})
md.use(deflistPlugin)
md.use(dovecot_markdown)
md.use(plantuml)

return md
}
Expand Down
63 changes: 0 additions & 63 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"name": "dovecot-ce-documentation",
"devDependencies": {
"@mdit/plugin-plantuml": "^0.22.3",
"@sindresorhus/slugify": "^2.2.1",
"camelcase": "^8.0.0",
"commander": "^13.1.0",
Expand Down