author : BruttherJOE
a simple guide on how to use md for text formatting.
md is useful and comes naturally to me for making notes.
for titles, do # (yourtitlehere)
for subtitles, do ## (yoursubtitlehere)
for subsubtitles, do ### (yoursubsubtitlehere)
and so on and so forth
to force line return (new line), add (" ") double spaces at the end of a line
this is a body. use
``` (yourtexthere) and then ``` again
for pictures, create a file called assets. stuff the pictures in. then you reference the picture from within the md file.
You can create tables by assembling a list of words and dividing them with hyphens - (for the first row), and then separating each column with a pipe |:
First Header | Second Header
------------ | -------------
Content from cell 1 | Content from cell 2
Content in the first column | Content in the second column
would become:
First Header | Second Header |
---|---|
Content from cell 1 | Content from cell 2 |
Content in the first column | Content in the second column |
inline code
`this inlines the code`
make an ./assets folder. link your picture onto your .md file with this link location
![this_does_not_matter](./assets/<your_picture_name_and_extension.jpg>)
Important info, remember that the link itself on github cannot have any spaces (use underscores _
)
This is some superscript text.
This is some subscript text.
This is some <sup>superscript</sup> text.
This is some <sub>subscript</sub> text.
<br/> : breaks a line
<p align="center">
<img width="460" height="300" src="http://www.fillmurray.com/460/300">
</p>