starcatsys/about
starcatsys/about
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Custom admonition "WIP"

Browse source
This commit is contained in:
thhsh-local 2025-04-21 12:39:50 -04:00
parent 9a59faaa23
commit 0a6da368d4
Signed by: thhsh-local
SSH key fingerprint: SHA256:bLOq3d7dN1v5+W5U6pQekP0rBm0YUtC9qvh3TDYyAsg
1 changed files with 20 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/handbook/meta/editing.md
View file

@ -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. 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.
```
--- ---