Markdown
The following is a short list of Markdown features that are handy to know when creating you're own documentation.
#Code Blocks Code blocks are the best. Since we work with lot's of code using the three back ticks "```" to start a code block and closing a code block with matching three back ticks "```" makes it simple to add code into your documentation and examples. You can also specify the type of highlighting for your project. In the case of Aruino projects it c++, or c as the formating and coloring options. You can choose not to show highlight with "no-highlght".
```c
/*
* Code goes here.
*/
void setup() {
}
void loop() {
}
```c
/*
* Code goes here.
*/
void setup() {
}
void loop() {
}
#Linking to files. The label for the hyperlink is placed between the brackets "[]" then the link is placed between the parantheises "()" When linking external documents or images the full link can go inside. When linking to pages or files in the wiki the first portion of the entry needs to say "(wiki/" everything after that is a page name or filename completed by the last ")".
[Link to remote site](http://github.com/proard)
[Link to remote file]( https://github.com/ProArd/attinysecretknock/blob/master/ATtinySecretKnock/ATtinySecretKnock.ino)
[Link to wiki files](wiki/TestLink)
#Headings Heading values are determined by the number of hash "#" symbols. A level 1 header would be one "#", level 2 "##", and level 3 "###"
# H1
## H2
### H3
#### H4
#Lists Lists can be ordered or unordered. It is possible to mix and match ordered and unordered lists. ##Numbered: Ordered lists just need to start with a number. GitHub wiki will substitute the correct in sequence number.
9. mmm
10. nnnn
- mmm
- nnnn
##Unordered lists Unordered lists can use *, -, or, + as symbols. It doesn't matter which as long as there exists a space between the symbol and the start of the list value.
* a
* b
+ c
+ d
- e
- f
- a
- b
- c
- d
- e
- f
#Linking to Images Linking to images is just another version of linking. Except the brackets "[]" denote the alt text for the image. The the parentheses hold the link to the image. If the image is in your project you can hyperlink to the raw file. It is possible to add the image to your project wiki by checking out the project's GitHub wiki, adding an image, committing, and then pushing it back into your GitHub project wiki.
