From ad485178163ed3740c4da6f3b3594742c976f064 Mon Sep 17 00:00:00 2001 From: jurgenhaas <juergen@paragon-es.de> Date: Mon, 11 Jan 2021 17:48:35 +0100 Subject: [PATCH] Configure search, theme and plantuml --- .gitignore | 1 + docker-compose.yml | 2 +- docs/diagrams/src/test1.puml | 6 ++++++ docs/index.md | 2 ++ mkdocs.yml | 13 +++++++++++++ 5 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 docs/diagrams/src/test1.puml diff --git a/.gitignore b/.gitignore index a9c0b03..9cab947 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ /site/ /.ahoy.l3d /.env +/docs/diagrams/out/ diff --git a/docker-compose.yml b/docker-compose.yml index 0e6af2f..839c1a8 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -9,7 +9,7 @@ services: - 8999:8000 environment: LIVE_RELOAD_SUPPORT: 'true' - ADD_MODULES: fontawesome-markdown mkdocs-git-revision-date-localized-plugin mkdocs-material + ADD_MODULES: fontawesome-markdown mkdocs-git-revision-date-localized-plugin mkdocs-material mkdocs-build-plantuml-plugin FAST_MODE: 'true' DOCS_DIRECTORY: /mkdocs volumes: diff --git a/docs/diagrams/src/test1.puml b/docs/diagrams/src/test1.puml new file mode 100644 index 0000000..1c36d35 --- /dev/null +++ b/docs/diagrams/src/test1.puml @@ -0,0 +1,6 @@ +@startuml + + Goofy -> MickeyMouse: calls + Goofy <-- MickeyMouse: responds + +@enduml diff --git a/docs/index.md b/docs/index.md index dc50930..51e346b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,5 @@ # Welcome to DevOps Tools For full documentation visit [mkdocs.org](https://mkdocs.org). + + diff --git a/mkdocs.yml b/mkdocs.yml index 1e62590..ad4cbab 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,17 @@ site_name: DevOps Tools +theme: + name: material +plugins: + - search: + lang: en + - build_plantuml: + render: "server" + server: "http://www.plantuml.com/plantuml" + output_format: "svg" + diagram_root: "docs/diagrams" + output_folder: "out" + input_folder: "src" + input_extensions: "" nav: - Home: index.md - Docker: -- GitLab