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

Add syntax reference to editing and syntax docs

Browse source 
- Introduced a new section on syntax in editing.md
- Added a detailed syntax reference in syntax.md
This commit is contained in:
thhsh-local 2025-04-29 22:03:20 -04:00
parent f0299921ff
commit 1ac79049b1
Signed by: thhsh-local
SSH key fingerprint: SHA256:bLOq3d7dN1v5+W5U6pQekP0rBm0YUtC9qvh3TDYyAsg
2 changed files with 4 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -5,7 +5,8 @@ This page contains information on editing/making changes to this website.
## Material for MkDocs ## Material for MkDocs
This site is written in Markdown and is generated using [:simple-materialformkdocs: Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) Insiders. The source Markdown is stored in the [:simple-forgejo: about Git repo](https://git.starcat.systems/starcatsys/about). This site is written in Markdown and is generated using [:simple-materialformkdocs: Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) Insiders. The source Markdown is stored in the [:simple-forgejo: about Git repo](https://git.starcat.systems/starcatsys/about).
## Syntax
Please see [:octicons-arrow-right-16: Syntax](syntax.md) for reference on various Material for MkDocs syntax you can use in your Markdown, and specific usage on this site.
--- ---

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

@ -1,5 +1,7 @@
# Syntax # Syntax
You can find a reference for the syntax used in writing this site in the Material for MkDocs [:simple-materialformkdocs: Reference section](https://squidfunk.github.io/mkdocs-material/reference/). On this particular site, there are some specific syntax point that we use. This page is intended to provide a reference for those specifics.
## Icons ## Icons
Reference for all available Material for MkDocs icons: [:simple-materialformkdocs: Icons, Emojis](https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/) Reference for all available Material for MkDocs icons: [:simple-materialformkdocs: Icons, Emojis](https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/)