From 0a6da368d4fa5ea4d9f7c6937fa1d9100b774bc8 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 21 Apr 2025 12:39:50 -0400 Subject: [PATCH] Custom admonition "WIP" --- docs/handbook/meta/editing.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/handbook/meta/editing.md b/docs/handbook/meta/editing.md index d7e6c65..3f8b6a1 100644 --- a/docs/handbook/meta/editing.md +++ b/docs/handbook/meta/editing.md @@ -83,6 +83,26 @@ Here are some common admonitions, when you might use them, and quick code snippe Information about a known bug in a current version. Whenever possible, provide a link to the issue report. Place a link back to the page with this admonition, in the issue report so that the admonition can be removed when the bug is closed. ``` +### Custom +We've modified a couple of the standard admonitions to mean something a little different on this site. + +#### Work in Progress +For pages that aren't yet complete, and need revisions (that we know are going to be revised sooner/more frequently than a typical page.) + +Typically, we will put this at the bottom of the page content, with a dividing line between any page content and this admonition. + +Example page with this Work in Progress admonition: + +??? quote "Syntax" + Copy and paste at the bottom of page content: + ``` + --- + + !!! example "Work in Progress" + This page is not complete, and is subject to change. + + Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. + ``` ---