From 3eb4963e51e562908cb430b52eb2362b22854f63 Mon Sep 17 00:00:00 2001 From: Remi Gau Date: Thu, 21 Mar 2024 11:17:57 -0400 Subject: [PATCH] update doc --- CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c34f9cb514..5e29414280 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -257,6 +257,9 @@ The keyword for the heading must be one of the following: - example - quote +Do note put [macros](#using-macros) in admonitions, +as this will likely not give the output you expect. + ## Using macros We use [mkdocs-macros](https://mkdocs-macros-plugin.readthedocs.io/en/latest/)