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

Add deprecated admonition

Browse source
This commit is contained in:
thhsh-local 2025-05-20 12:57:15 -04:00
parent 5b4a0a8845
commit e305c9a8df
Signed by: thhsh-local
SSH key fingerprint: SHA256:bLOq3d7dN1v5+W5U6pQekP0rBm0YUtC9qvh3TDYyAsg
2 changed files with 33 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

15
docs/handbook/meta/syntax.md
View file

@ -96,6 +96,21 @@ Here are some common admonitions, when you might use them, and quick code snippe
### Custom
We've modified a couple of the standard admonitions to mean something a little different on this site.
#### Deprecated
For pages that were once accurate, but are either no longer accurate and not being updated, or have become obsolete due to discontinuation, etc.
!!! deprecated "Deprecated"
The `deprecated` admonition looks like this.
??? quote "Syntax"
Copy and paste at the top of page content:
```
!!! deprecated "Deprecated"
The contents of this page are deprecated. Do not rely on any information on this page to be accurate, as it is not being updated.
Please see <insert page link, if available> for the equivalet updated information.
```
#### 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.)