← Back to courses
Programming Fundamentals
Markdown for Documentation
Two days to writing a README people actually read
A two-day classroom workshop on GitHub's basic writing and formatting syntax: headings, styling text, quoting text and code, links, images, lists and task lists, mentions and references, footnotes and alerts. You finish by writing a README for a project of your own. This workshop prepares for no exam.
6Modules
BeginnerLevel
2 daysDuration
COURSE THUMBNAIL
What you will be able to do
Format a document in Markdown
Show code and link between sections
Write a clear README
Course outline
01
Headings, paragraphs and styling text
02
Quoting text and quoting code
03
Links, section links and images
04
Lists, nested lists and task lists
05
Mentioning people; referencing issues and pull requests
06
Footnotes, alerts and comments
Tools you will use
MarkdownGitHubVisual Studio Code
What you need
General computer skills
