Teaching Tuesday: Markdown

Transcript

1. Markdown Teaching Tuesday, 13.03.2018
2. What is it?
3. Plain-text format
4. Uses keyboard characters to indicate meaning
5. Whitespace matters
6. There are different “flavors” (We mostly use GitHub-flavored markdown at Kanopi)
7. The Basics
8. Headings # Level One ## Level Two ### Level Three
9. Lists * Unordered List * Unordered List 1. Ordered List 1. Ordered List 2. Ordered List
10. Links [Text to link](https://where-to-go.com)
11. Emphasis **Bold Text** *Italic Text* _Italic Text_
12. Code (Preformatted Text) `this is a line of code`
 ``` This is a block of code ```
13. Images 
14. Not so Basics
15. Tables (GitHub flavored)
 Column One Header | Column Two Header | Column Three Header ------ | ------ | ------ Row One, Column One | Row One, Column Two | Row One, Column Three
 Row Two, Column One | Row Two, Column Two | Row Two, Column Three
16. Where can I use this?
17. GitHub *.md files
 Pull Requests Issues
18. Teamwork Tasks (but not comments)
19. Teamwork Notebooks
20. Requirements Documentation (MkDocs)
21. Slack (Kinda)
22. Resources • Markdown Basics: https://daringfireball.net/projects/markdown/basics • Cheatsheet (GitHub-flavored): https://github.com/adam-p/markdown- here/wiki/Markdown-Cheatsheet • Stack Edit (in-browser editor): https://stackedit.io/ • Bear: http://www.bear-writer.com/ • MacDown: https://macdown.uranusjr.com/ • Your code editor of choice likely has a markdown preview plugin as well.