Markdown for Wikis - VTAstrobotics/Documentation GitHub Wiki
done by
<h2 align="center">Objective: To show formatting examples & tips with Markdown.</h>
***
### Table of Contents
- [Big header](#big-header)
- [Small header](#custom-tag)
^^ two spaces
You can bold, italicize, both, code
, strikethrough, subscript, superscript, and hyperlink.
# Big header
You can **bold**, _italicize_, ***both***, `code`, ~~strikethrough~~, <sub>subscript</sub>, <sup>superscript</sup>, and [hyperlink](https://google.com).
You can also format a block of code!
It comes with a copy button on the right.
And if you specify the language, syntax highlighting, too!
For example,
for n in range(len(my_list)): print(n)
is a line of Python
```python
You can also format a block of code!
It comes with a copy button on the right.
And if you specify the language, syntax highlighting, too!
For example,
for n in range(len(my_list)): print(n)
is a line of Python
```
(This is linked to by the "Small header" above)
## <a name="custom-tag">Well this isn't what the table of contents says the header would be</a>
(This is linked to by the "Small header" above)
You can also use block-quotes.
> You can also use block-quotes.
The easiest way to make a link to a header within your page is to automatically let Markdown define out your tag.
A
tag
is a lowercase-only, custom key with no spaces.
If you choose this route, your tag will be the same as the content of the line you link to, with invalid characters replaced by a -
or deleted.
For example, the tag for the line
I'm so cool
would be im-so-cool
. Notice how the spaces (
) were replaced with hyphens (-
), and the apostrophe ('
) was deleted.
A quick way to check what your tag would be is to write the header and then Preview
it. So I could write
# I'm so cool
and in the Preview
pane, after hovering my mouse on the text, it would have a link to the left of it, like this:
By hovering over that link, at the bottom of your window, you will see the tag at the end of the URL:
The part after the #
is your tag! (im-so-cool
)
HEADER
EXCESS TEXT / DETAILS GO HERE. You can use Markdown here too.
<details>
<summary>HEADER</summary>
EXCESS TEXT / DETAILS GO HERE. You can use Markdown here too.
</details>
Please note the empty lines after the </summary>
and </details>
closing tags.
Example image below
<details>
<summary>Example image below</summary>
![image-alt-text](https://drive.google.com/uc?export=view&id=1VP57u6UEHSano3c133HUwfTiMbs--qQ8)
</details>
Emojis: 🤖
Emojis: :robot:
You can find a complete list here.