A handy Mac OS Markdown editor: Muo
This is bold text
This is bold text
This is italic text
This is italic text
Strikethrough
Blockquotes can also be nested...
...by using additional greater-than signs right next to each other...
...or with spaces between arrows.
Unordered
- Create a list by starting a line with
+,-, or* - Sub-lists are made by indenting 2 spaces:
- Marker character change forces new list start:
- Ac tristique libero volutpat at
- Facilisis in pretium nisl aliquet
- Nulla volutpat aliquam velit
- Marker character change forces new list start:
- Very easy!
Ordered
-
Lorem ipsum dolor sit amet
-
Consectetur adipiscing elit
-
Integer molestie lorem at massa
-
You can use sequential numbers...
-
...or keep all the numbers as
1.
Start numbering with offset:
- foo
- bar
Inline code
Indented code
// Some comments
line 1 of code
line 2 of code
line 3 of code
Block code "fences"
Sample text here...
Syntax highlighting
var foo = function (bar) {
return bar++;
};
console.log(foo(5));| Option | Description |
|---|---|
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
Right aligned columns
| Option | Description |
|---|---|
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
Autoconverted link https://github.com/nodeca/pica
On Github, you can also link to headers in the same document using #
[Blockquotes](#blockquotes)
Like links, Images also have a footnote style syntax
![Alt text][id]
With a reference later in the document defining the URL location:
[id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat"
README files should contain a few key parts:
- name of the project
- short description
- background / problem statement / solution
- installation / deployment
- usage
- troubleshooting / FAQs
- additional resources / assets
- links to any other supporting docs.
On Mac, there are some special hotkeys you can use to take screenshots:
| Key Combo | Type | Example |
|---|---|---|
Cmd-Shift-3 (⌘-⇧-3) |
Capture entire Screen |  |
Cmd-Ctrl-Shift-3 (⌘-Ctrl-⇧-3) |
Capture entire Screen + Add to clipboard | |
Cmd-Shift-4 (⌘-⇧-4) |
Capture portion of Screen |  |
Cmd-Ctrl-Shift-4 (⌘-Ctrl-⇧-4) |
Capture portion of Screen + Add to clipboard | |
Cmd-Shift-4-Spacebar (⌘-⇧-4-Space) |
Capture entire window (adds window shadow) |  |
Cmd-Ctrl-Shift-4-Spacebar (⌘-Ctrl-⇧-4-Space) |
Capture entire window (adds window shadow) + Adds to clipboard | |
These will automatically be saved on your Desktop. To change the default location, run the following command in your terminal:
defaults write com.apple.screencapture location /Users/username/Pictures/screenshots/;killall SystemUIServer
where /Users/username/Pictures/screenshots/ is the path of the folder where you want your screenshots to be saved.
As Github documentation requires a url for embedding images, uploading the image to an image host (like imgur) is helpful. There are tools available for auto upload of those screenshots to Imgur:
You can embed animated gifs into your documentation as well! Doing so can add character:
or valuable walkthrough documentation:
Recording animated screenshots is really easy, on Windows/Mac OS X, you can use LICEcap, which is a free animated gif screen recorder.