Skip to content

Add support for PlantUML diagrams

Sarah German requested to merge 14-plantuml into main

What does this MR do and why?

Adds support for PlantUML diagrams.

The implementation here borrows heavily from Google's Docsy theme:

Closes #14 (closed)

Screenshots, screen recordings, or links to review app

Before After
image image

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

  1. Configure a local GitLab Docs environment: https://gitlab.com/gitlab-org/technical-writing-group/gitlab-docs-hugo/-/blob/main/doc/setup.md.
  2. Visit a page with a plantUML diagram, and verify it looks the same as the Nanoc site. Here are a few examples:

Tip: You can quickly visit the Nanoc version of these pages by using the link to "17.1" on the Versions dropdown.

Merge request acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by Sarah German

Merge request reports