Contributing to the Wiki: Difference between revisions
m Fix code sections to restore single "=" where they should be |
m Fix closing "pre" tag |
||
(One intermediate revision by the same user not shown) | |||
Line 62: | Line 62: | ||
| [https://heliohost.org Link 1] || [https://heliohost.org Link 2] || [https://heliohost.org Link 3] | | [https://heliohost.org Link 1] || [https://heliohost.org Link 2] || [https://heliohost.org Link 3] | ||
|} | |} | ||
== Code == | |||
=== Inline Code === | |||
For inline code, use <code><code></code> and <code></code></code> | |||
This syntax: | |||
<code> | |||
<code>sudo whoami</code> | |||
</code> | |||
Will display as: | |||
<code>sudo whoami</code> | |||
=== Code Blocks === | |||
For code blocks, use <code><pre></code> and <code></pre></code> | |||
This syntax: | |||
<pre> | |||
<pre> | |||
#!/usr/bin/python3.12 | |||
print("Content-Type: text/html\n\n") | |||
print("Heliohost rules!") | |||
</pre> | |||
</pre> | |||
Will display as: | |||
<pre> | |||
#!/usr/bin/python3.12 | |||
print("Content-Type: text/html\n\n") | |||
print("Heliohost rules!") | |||
</pre> | |||
=== Special Characters === | |||
To show <code><</code> and <code>></code> in plain text instead of having them interpreted as tags, use <code>&lt;</code> for <code><</code> and <code>&gt;</code> for <code>></code>. | |||
== Other Ways to Help == | == Other Ways to Help == | ||
There are many other ways you can help us keep improving. Learn how you can contribute to our community on our [[:How_You_Can_Help|How You Can Help]] page. | There are many other ways you can help us keep improving. Learn how you can contribute to our community on our [[:How_You_Can_Help|How You Can Help]] page. |
Latest revision as of 19:38, 24 January 2025
Contributing
We welcome contributions to our community powered Wiki
Before editing a file, please read our Documentation Style Guide, to help us maintain consistency across user guidance documentation.
Find the file you would like to edit, and then edit it.
Formatting Hints
Use MediaWiki's Text Formatting Guide, their Cheatsheet, and their Image Guide for screenshots.
Headers
Using H2 headers for title sections can be done with the following code:
== Title Section ==
Info
To use an Info code block, use:
{{Info|this is info text}}
Caution
To use a Caution code block, use:
{{Caution|this is Caution text}}
Danger
To use a Danger code block, use:
{{Danger|this is danger text}}
Tables
This code:
{| class="wikitable" style="margin:auto" |+ style="caption-side:top; |'''Table Caption''' |- ! Header 1 !! Header 2 !! Header 3 |- | Cell 1 || Cell 2 || Cell 3 |- | [https://heliohost.org Link 1] || [https://heliohost.org Link 2] || [https://heliohost.org Link 3] |}
Will display as:
Header 1 | Header 2 | Header 3 |
---|---|---|
Cell 1 | Cell 2 | Cell 3 |
Link 1 | Link 2 | Link 3 |
Code
Inline Code
For inline code, use <code>
and </code>
This syntax:
<code>sudo whoami</code>
Will display as:
sudo whoami
Code Blocks
For code blocks, use <pre>
and </pre>
This syntax:
<pre> #!/usr/bin/python3.12 print("Content-Type: text/html\n\n") print("Heliohost rules!") </pre>
Will display as:
#!/usr/bin/python3.12 print("Content-Type: text/html\n\n") print("Heliohost rules!")
Special Characters
To show <
and >
in plain text instead of having them interpreted as tags, use <
for <
and >
for >
.
Other Ways to Help
There are many other ways you can help us keep improving. Learn how you can contribute to our community on our How You Can Help page.