Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid HTML.
Thus, Markdown is two things:
- a plain text formatting syntax; and,
- a software tool that converts Markdown to HTML.
Unlike text which has been formatted with HTML markup, which has obvious tags and formatting instructions, Markdown is a formatting syntax for text that can be read by humans and can be easily converted to HTML.
README.md on Github
Every repo should contain a README file, which is a document intended to describe the project.
On GitHub, if a repo has a README.md file in its main (top-level) directory, the README file is automatically converted into formatted HTML and displayed on the repo web page, underneath the list of files and directories.
Required: Learn Markdown
- Start with Markdown in 3 Minutes.
- Learn About README.md files.
Optional: Learn More Markdown
- Markdown Dingus
- Markdown Tutorial
- Markdown Basics
- Another Markdown Cheat Sheet
- Github Flavored Markdown: GitHub’s variant of Markdown.
- Github Flavored Markdown :emoji: