Skip to content

Markdown Language

Markdown is used for writing this website. So, the first thing I need to learn is about Markdown Language.

About Markdown

Markdown icon

Figure 1. Markdown icon

  • lightweight markup language
  • was created by John Gruber in 2004

Basic Syntax

This section notes about Markdown basic syntax.

  • Insert a picture in Markdown: ![picture_name](direction_to_picture)
  • Insert a hyperlink: [Name](Link). Hyperlink is used in References in this note.
  • Colour for Text: (need to use HTML language)
    Red, Green, Blue, Yellow, Pink, Violet, Orange,
  • Code and emphasize C syntax:
    int main() {
        printf("Hello world!");
        return 0;
    }
  • Quote (put '>' before writing quote):

This is example of block quote
This is example of block quote

  • Horizontal Rule: put a horizontal rule in doc by typing ***, see result below

  • Task list (do not success by now)

    • [x] Write the press release
    • [ ] Update the website
    • [ ] Contact the media
  • Inserting a figure to docs:
    refer About Markdown in this page for example

!!! note with "admonition" in mkdocs.yml add markdown_extensions: -admonition to mkdocs.yml file. Read more at Markdown Extentions

Markdown Extentions

Got information about markdown extentions at https://squidfunk.github.io/mkdocs-material/extensions/admonition/

PyMdown

https://squidfunk.github.io/mkdocs-material/extensions/pymdown/

References

  1. The Markdown Guide - Matt Cone
  2. Markdown Guide - Website
  3. Basic writing and formatting syntax - GitHub
  4. Markdown Guide - Gitlab
Back to top