Using Github's Markdown - heinsch-fa/behave-app GitHub Wiki
Markdown in Github is different from some of the other versions out there.
Note: They have removed most of the HTML code that used to work for security reasons.
Here are a few links to get you started. Information in The Markdown Guide may not work for the Github wiki.
- Github's Markdown Cheatsheet
- The Markdown Guide
- For more detailed information and examples, visit these links.
To open a link in a new window, you must click on the Ctrl key and then the link.
-
To link to a website, use single brackets around a title, and with no spaces, use parentheses around the entire URL.
-
To link to another page in the wiki, copy the page title. Then use double square brackets around the entire title with no spaces. If the title contains an image, it must be included.
-
To link to another section in the same page, use the format for a website with single brackets to add a title and parentheses around the actual link. To make the link, you can either
- create a link by adding a number sign to the beginning of the header, use only lower class letters, and replace any spaces with dashes. To view the Lists below, the link would be LISTS inside single brackets and #lists inside the parentheses. There should be no spaces.
- click Preview to preview the page and copy the link. You will need to trim the link to include only the page title and link, or it may link to the same page on a different site (e.g., draft).
- Finally, to link to a specific section on another page, add a title in single brackets and combine the page title and the section title in parentheses. The link to the Behave7 template page would Link to a section n the same page, the format is similar to a web link. add a title using single brackets. With no spaces, use parentheses around the link. You can create it to . add a number sign to the beginning, change the heading to small letters, and replace any spaces with a dash.
- Or, click on Preview, right-click on the link, return to the Write window and paste it.
If you want make sure each line of text you enter is actually a separate line and not a paragraph, add a blank line in the middle.
Option 1.
If I want those three lines to show up as three lines...
I can extra line in between them.
But the spacing will also show up.
If you want lines of text to show up without spaces, use the HTML break at the end of the line.
The break is < br >. Just remove the spaces between the angle brackets brackets and the letters.
You do not need to add a break within an ordered or unordered list.
Sometimes you need to add a space between a character and a word, such as in the heading...
Use one number sign (#) and a space before Heading 1, two number signs (##) and a space before Heading 2, etc.
A gray line is automatically added after a heading.
...And sometimes you don't, such as when you want to emphasize the text.
- Use an underscore before and after a word for Italics.
- Use double asterisks before and after a word for Bold font.
- To use bold italics, use both of them, such as _ ** Bold Italics ** _ without the spaces.
- Bold Italics
- To highlight words, you can use the code for < mark > will start it and < / mark > will end it. Remove all spaces to make it work. The words will be highlighted with yellow.
- To
highlight words with gray, use a grave accent / backtick before and after the word or phrase without spaces. You can also addadditional font changesaround the grave accent. - For a superscript, use the HTML code < sup > to start and < /sup > to end without the spaces: Behave7.
- For a Subscript, use < sub > to start and < /sub to end > without the spaces: H2O.
Github allows you to create both ordered and unordered lists. Lists can have up to 10 levels, but there are only three or four symbols used for unordered lists.
Unordered Lists
- Start the first level at the left. Use a -, *, or + to make it an unordered list.
- Using three characters seems to work well. Therefore...
- Add three spaces before the second level and use - or * as above.
- Add six spaces before the third level. Use - or * as above.
- Markdown will use a different icon for the first three levels.
- Add six spaces before the third level. Use - or * as above.
Ordered Lists
For an ordered list, you can enter the numbers in any order and use any number. But the list must start with "1" and every number needs a period after it. If you check the code, you will see that I used the numbers in quotes to number my list.
- First item number is "1"
a. To show a second level, use three spaces before the text.
b. It does not handle the alphabet well.
c. Add an HTML break after the each line, and the letters must be in alphabetical order.
- Numbers work just fine, though.
- Use any number, and Markdown will fix it.
- You can also mix ordered...
- and unordered lists.
- Second item number is "8"
- Third item number is "20"
- Fourth item number is "0"
A list can have 10 levels, but there are only four bullets that it rotates through.
- First item
a. Add three spaces before the second level.
q. But remember to add the break and that Markdown will not correct letters.
- Second Item.
- indented numbers work just fine.
- and show up differently.
- Third item.
- You can also mix ordered...
- and unordered lists.