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

Custom admonitions "WIP" and "Placeholder" with examples

Browse source
This commit is contained in:
thhsh-local 2025-04-21 13:07:40 -04:00
parent ad24ce1318
commit 466be94b50
Signed by: thhsh-local
SSH key fingerprint: SHA256:bLOq3d7dN1v5+W5U6pQekP0rBm0YUtC9qvh3TDYyAsg
3 changed files with 42 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -104,6 +104,25 @@ Example page with this Work in Progress admonition: [:octicons-arrow-right-16: E
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.
```
#### Placeholder Page
For pages that are newly created and have no (or very little) content on the page itself. Also used for `index.md` pages in directories that have other contents, but no content on the directory index.
Example page with the Placeholder Page admonition: [:octicons-arrow-right-16: Example Placeholder Page Admonition](example_pages/example_placeholder_page_admonition.md)
??? quote "Syntax"
Copy and paste at the bottom of page content:
```
!!! abstract "Placeholder Page"
This is a placeholder page. Please see the site navigation for any sub-pages that exist.
```
!!! tip
Typically, any page that is marked as a Placeholder Page should also be marked with the **Work in Progress** admonition because they are, by their nature, incomplete.
Example page with the Placeholder and WIP admonitions: [:octicons-arrow-right-16: Example Placeholder and WIP Admonitions](example_pages/example_wip_placeholder_admonitions.md)
Source code that you can quickly copy from when making an index or placeholder page is located [:simple-forgejo: here](https://git.starcat.systems/starcatsys/about_docs/src/branch/main/docs/handbook/meta/example_pages/example_wip_placeholder_admonitions.md).
---
!!! example "Work in Progress"