Markdown Basics - pcgoddard/Burchardlab_Tutorials GitHub Wiki
- Sublime Add-ons
- Headers
- Emphasis
- Lists
- Links
- Block Quotes
- Code Inserts
- Tables
- Line Breaks
- Using Special Characters
- Emojis ✨
- MarkdownEditor # for easier visualization pre-publication
- OmniMarkupPreviewer # for previewing fully formatted document
- ctrl + alt + o
- OR MarkdownBuddy
Use # to indicate header level
combined: ***word*** or ___word___
strikethrough: <del>word<del> or ~~ word ~~
- unordered
- lists
- use *
- and -
- ordered
- lists
- use
- numbers
- but not letters
- number of tabs determines bullet level
- - [x] this is a complete item
- - [ ] this is an incomplete item
- - [ ] list autopopulates format
example: wikipedia
\[Alt Text](url)
All linked images must be hosted online. You can link to an image on your local machine but it will not be viewable in the published markdown on other devices. When the image is not publishable, the Alt Text input will be shown.
\!\[Alt Text](url)
\<img src="url" alt="Alt Text" width="200"/>
*note: the alt="" input is optional
This requires use of anchor tags where you want the table of contents to link to.
\<a name="anchor_tag"></a>
# This is my header!
- note: remove the
\before the first>to activate the anchor tag - personal preference: I like to put the anchor tag above the tagged section so that when the link jumps to that section you still see the header
You can then link to that line from anywhere in the document using:
\[My header\]\(\#anchor_tag\)
the following lines will be a quote
> it was the best of times
> it was the worst of times
it was the best of times
it was the worst of times
This is your `code` to highlight
This is your code to highlight
```javascript
function test() {
console.log("hello world");
```
function test() {
console.log("hello world");
}to put any text in a code box, just indent it once
any text
- tables use | and - to indicate field divisions
column 1 | column 2
---------|--------- # this line is necessary to indicate table format
cell 1.1 | cell 2.1
cell 1.2 | cell 2.2
| column 1 | column 2 |
|---|---|
| cell 1.1 | cell 2.1 |
| cell 1.2 | cell 2.2 |
- 3 or more * - or _
removes special syntax meaning: italic v. *asterisks*
\character can be used on the following:
\ ` * # _ - + . { } [ ] ( ) !
(just remove the spaces)
👍 = : + 1 :
✨ = : sparkles :
= : octocat :