Markdown Tips & Introduction

Tips:

  • Markdown Preview Enhanced can create TOC for your markdown file. You can press cmd-shift-p then choose Markdown Preview Enhanced: Create Toc to create TOC. Multiple TOCs can be created. To exclude a heading from the TOC, append {ignore=true} after your heading. [link]
  • Cheatsheet:
    • Markdown cheatsheet from Markdown Guide (link)
    • Markdown cheatsheet from GitHub (link)
    • Extended syntax (link)
  • svg resources

If you are not familiar with Markdown

What is Markdown?

According to wiki:

Markdown is a lightweight markup language with plain-text-formatting syntax. Its design allows it to be converted to many output formats, but the original tool by the same name only supports HTML. Markdown is often used to format readme files, for writing messages in online discussion forums, and to create rich text using a plain text editor.

How to open and create the Markdown files?

  • I recommend using the markdown editor Typora, which gives you a seamless experience as both a reader and a writer. It is free fo Windows/MacOS/Linux users.
  • But you can use any text editor (such as Notepad++ on Windows or Sublime Text on MacOS/Linux) to open and create the *.md files.

How to write?

To create a markdown-based documentation:

  • You are not required to learn any syntax if you are using Typora.
  • You can learn basic Markdown syntax within 5 mins. See the resources:
    • Markdown cheatsheet from Markdown Guide (link)
    • Markdown cheatsheet from GitHub (link)
    • Extended syntax (link)

results matching ""

    No results matching ""