Skip to main content

Introduction

markdownlogo

About Markdown​

Markdown is a lightweight and easy-to-read markup language, designed to be converted to HTML. It was created with the goal of offering an easy-to-write and read syntax, while allowing easy conversion to HTML. Markdown is widely used in online environments to create simple documents with basic formatting.

When you write in Markdown, the text is stored in a plain text file that has a .md or .markdown extension.

Something needs to convert (process) this Markdown file to HTML and then display it.

Alt text

Within VSCode, which already has an integrated markdown app, you can open a markdown file and it will be shown as this page would look in HTML.

Alt text

Like vscode, many other places, including code repositories, already interpret .md files and show them in HTML.

I recommend the VSCode extension called markdown lint (DavidAnson.vscode-markdownlint), as it offers valuable support during the writing process.

If you're starting with Markdown, the official documentation is a valuable source of information.

Recommendations​

  1. Consult the Official Documentation:

    • Always refer to the official documentation to get accurate and comprehensive information.

  2. Learn Markup Deeply:

    • Instead of depending on ready-made editors, invest time in learning Markdown markup effectively.

  3. Use Visual Studio Code for Real-Time Editing:

    • Take advantage of Visual Studio Code, which offers real-time visualization of what you're typing, eliminating the need for other editors.