Overview
Text can be italicized or bolded as well as monospaced
.
You can *escape certain* special characters.
Some section 2 text
Some more text.
Add an image with:
You can inline an image or other directive with the command.
- Bullet are made like this
- Point levels must be consistent
- Sub-bullets
- Sub-sub-bullets
- Lists
- Term
- Definition for term
- Term2
- Definition for term 2
List of Things: | item1 - these are 'field lists' not bulleted lists item2 item 3 |
---|---|
Something: | single item |
Someitem: | single item |
A code example prefix must always end with double colon like it's presenting something:
Anything indented is part of the preformatted block Until It gets back to Allll the way left
Now we're out of the preformatted block.
There are three equivalents: code
, sourcecode
, and code-block
.
import os
print(help(os))
# Equivalent
Web addresses by themselves will auto link, like this: https://www.devdungeon.com
You can also inline custom links: Google search engine
This is a simple link to Google with the link defined separately.
This is a link to the Python website.
This is a link back to Section 1. You can link based off of the heading name within a document.
Footnote Reference [1]
[1] | This is footnote number one that would go at the bottom of the document. |
Or autonumbered [#]
[2] | This automatically becomes second, based on the 1 already existing. |
Any 4+ repeated characters with blank lines surrounding it becomes an hr line, like this.
Normally you can break the line in the middle of a paragraph and it will
ignore the newline. If you want to preserve the newlines, use the |
prefix
on the lines. For example: