• $\fbox{Table~of~Contents}$

Markdown formatting (.md)

<aside> ⚠️ A word of caution: do not rename the extension of .md files. If you do, the file type will either not change or the format will become distorted. There is special conversion software available for changing a file from one type to another.

Markdown is a lightweight markup language intended for one purpose: to be used to format text with plain text formatting syntax. Markdown is not a replacement for HTML because its syntax is very small — it contains only a small subset of HTML tags. The reason behind Markdown is to make it easy to read, write, and edit prose.

In other words: HTML is a publishing format, while Markdown is a writing format.

</aside>

'''|''' This is a code block '''| | | Link |Text|Click for porn| [Click for porn](<https://www.pornhub.com>) | | Lists |-, , or +| This will look

• The same as this| | | Task lists |- [ ]|- [ ] This is a task list` | |

Relative links

Syntax → [Example text](docs/EXAMPLE.md)

• The path of the link will be relative to the current file
  • Links starting with / will be relative to the repository root
  • You can use all relative link operands, such as ./ & ../
• Relative links are easier for users who clone your repository
  • Absolute links may not work in clones of your repository
  • It’s recommend that you use relative links to refer to other files within your repository

Images

Syntax → ![This is an image](<https://myoctocat.com/assets/images/base-octocat.svg>)

• Notice it’s the same as a relative link, just with a ! preceding it
• Examples

Ignoring Markdown formatting

• You can ignore (or escape) Markdown formatting by using \\ before the Markdown character
• Examples

Common MIMEs (media types)

• Two primary MIME types are important for the role of default types:
  • text/plain is the default value for textual files
    • A textual file should be human-readable and must not contain binary data
  • application/octet-stream is the default value for all other cases
    • An unknown file type should use this type
    • Browsers pay particular care when manipulating these files, to protect users from software vulnerabilities and possible dangerous behavior