Markdown

Markdown is a lightweight markup language that is widely used for formatting and structuring plain text documents. It is designed to be easy to read and write, while also being easily converted into HTML or other formats.

Markdown document files will have a file extension of .md

guide on "How to use/write Markdown": https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

What is a README file?

A README is a text file that introduces and explains a project. It contains information that is commonly required to understand what the project is about.

A README file is often written as a markdown file. For an example, read this README file.

How to create a Markdown file

A markdown file can be created with any code OR basic text editors as long as the file extension is set to .md.

The following link is a collection of editors and markdown previewers: https://github.com/mundimark/awesome-markdown-editors

Last updated