Formatting¶

Adding Hyperlinks¶

You can add links to other Catalyst Guide pages or to websites using:

You can add links to images as well!

[Click to visit Example!](https://www.example.com/)

[How to Contribute!](../README.md)

Highlighting Changes¶

Text can be deleted and replacement text added. This can also be combined into onea single operation. Highlighting is also possible and comments can be added inline.

Highlighting Text¶

You can highlight text with a simple syntax that's is more convient than usual HTML tags.

==This was marked (highlight)==

^^This was inserted (underline)^^

~~This was deleted (strikethrough)~~

Sub and Superscripts¶

Text can be subscripted (below) or superscripted (above) using simple syntax.

H~2~O

2^X^

Adding keyboard keys¶

Using the below syntax, you can render keyboard keys and mouse buttons.

You can see shortcodes at Python Markdown Extensions

++ctrl+alt+del++

++print-screen+eject+caps-lock++

++left-button+middle-button+right-button++

Tool Tips¶

You can add tool tips to text that can contain links if you'd like!

[Hover me](https://example.com "I'm a tooltip!")

You can also add tooltips to Icons!

:material-information-outline:{ title="Important information" }

Adding Abbreviations¶

Abbreviations can be defined by using a special syntax, starting with a * and immediately followed by the term or acronym to be associated in square brackets.

The HTML specification is maintained by the W3C.

*[HTML]: Hyper Text Markup Language
*[W3C]: World Wide Web Consortium

Adding a Glossary¶

You can add a glossary or footnotes to text that will be displayed at the bottom of the current page and is clickable in both directions.

Nuclear fission[^1] is a reaction in which the nucleus[^2] of an atom splits into two or more smaller nuclei.

[^1]:
    This term will be added to the bottom of the current page and is clickable.
[^2]:
    This is also some term at the bottom of the page.

Adding Hidden Comments¶

You can add comments for other contributors that will be hidden on the live Catalyst site.

<!--- This comment will not be rendered in the final HTML file. --->

<!--- 
This multiline comment will also 
not be rendered in the final HTML file. 
--->

The two comment methods will show in View Source, if you don't want that you can use this format to have truly hidden comments.

[//]: # (This comment will not show in the final HTML or "View Source")