2.6 KiB
Editing this site
This page contains information on editing/making changes to this website.
Material for MkDocs
This site is written in Markdown and is generated using :simple-materialformkdocs: Material for MkDocs Insiders. The source Markdown is stored in the :simple-forgejo: about_docs Git repo.
Icons
Reference for all available Material for MkDocs icons: :simple-materialformkdocs: Icons, Emojis
Commonly-used icons for links
:octicons-arrow-right-16: :octicons-arrow-right-16: - used for links within the wiki
:octicons-tab-external-16: :octicons-tab-external-16: - used for links outside the wiki, but within StarCat Systems
:octicons-link-external-16: :octicons-link-external-16: - used for external links to sites not controlled by StarCat Systems
Coloring icons
You can add a color to an icon by adding the CSS color after the icon, like this:
:fontawesome-solid-dragon:{ .bug-pink } :fontawesome-solid-dragon:{ .bug-pink }
Currently, the available configured colors are based off the built-in admonition colors and icons, as follows:
:fontawesome-regular-note-sticky:{ .note-blue } :fontawesome-regular-note-sticky:{ .note-blue }
:octicons-info-16:{ .info-blue } :octicons-info-16:{ .info-blue }
:octicons-flame-16:{ .tip-teal } :octicons-flame-16:{ .tip-teal }
:octicons-check-16:{ .success-green } :octicons-check-16:{ .success-green }
:octicons-question-16:{ .question-green } :octicons-question-16:{ .question-green }
:octicons-alert-16:{ .warning-yellow } :octicons-alert-16:{ .warning-yellow }
:octicons-x-circle-16:{ .failure-red } :octicons-x-circle-16:{ .failure-red }
:octicons-zap-16:{ .danger-red } :octicons-zap-16:{ .danger-red }
:octicons-bug-16:{ .bug-pink } :octicons-bug-16:{ .bug-pink }
:octicons-beaker-16:{ .example-purple } :octicons-beaker-16:{ .example-purple }
:octicons-quote-16:{ .quote-grey } :octicons-quote-16:{ .quote-grey }
:octicons-flame-16:{ .tip-teal } Want to know how these colors work? Check out :simple-forgejo: the CSS in the source.
!!! 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.