markdown: implement a TODO container

README.md

@@ -274,3 +274,18 @@ Create a update tag based on a tag_name.
 The tag_name must be defined in `data/updates.js`.
 
 Example: `[[changed,tag_name]]`
+
+### Other Markdown Extensions
+
+#### TODO Container
+
+***Syntax:***
+
+```
+::: todo
+TODO text contents
+:::
+```
+
+Outputs a formatted TODO container, using the (optional) TODO text contents
+as the body.

docs/core/admin/limits.md

@@ -8,13 +8,11 @@ title: Limits
 Dovecot contains various built-in resource limits designed to prevent
 denial of service situations. This page lists those limits.
 
+::: todo
+This list is currently incomplete.
+:::
+
 ## Message Headers
 
 There is a `10 MB` limit for a single message header block, and a `50 MB`
 limit for all header blocks in a message.
-
-## TODO
-
-::: danger TODO
-List other limits here
-:::

docs/core/config/imap.md

@@ -85,7 +85,8 @@ mail_attribute_dict = proxy::metadata
 
 ### SPECIAL-USE
 
-TODO
+::: todo
+:::
 
 ### PREVIEW
 

docs/developers/debugging.md

@@ -151,8 +151,8 @@ dest=core.tar.gz
 
 ## Debugging Core Dumps in Other Systems
 
-::: warning TODO
-Move to Pro
+::: todo
+Move to Dovecot Pro documentation.
 :::
 
 If you have a tar.gz generated from dovecot-sysreport, you can debug it

lib/markdown.js

@@ -1,8 +1,18 @@
+import containerPlugin from 'markdown-it-container'
 import deflistPlugin from 'markdown-it-deflist'
 import { createMarkdownRenderer } from 'vitepress'
 import { loadData, loadDovecotLinks, resolveURL } from './utility.js'
 
 export async function dovecotMdExtend(md) {
+	md.use(containerPlugin, 'todo', {
+		render: function(tokens, idx) {
+			if (tokens[idx].nesting === 1) {
+				return '<div class="caution custom-block">\n<p class="custom-block-title">⚠️ TODO</p>'
+			} else {
+				return '</div>\n'
+			}
+		}
+	})
 	md.use(deflistPlugin)
 	md.use(dovecot_markdown, {
 		dovecotlinks: await loadDovecotLinks(),

package.json

@@ -6,6 +6,7 @@
     "fast-glob": "^3.3.2",
     "git-commit-info": "^2.0.2",
     "import": "^0.0.6",
+    "markdown-it-container": "^4.0.0",
     "markdown-it-deflist": "^3.0.0",
     "markdown-it-mathjax3": "^4.3.2",
     "pagefind": "^1.1.0",
@@ -17,7 +18,7 @@
     "unified": "^11.0.5",
     "unist-util-map": "^4.0.0",
     "vitepress": "^1.2.3",
-    "vitepress-plugin-pagefind": "^0.4.1",
+    "vitepress-plugin-pagefind": "^0.4.3",
     "vitepress-sidebar": "^1.23.2"
   },
   "scripts": {