AICollection Help

Descriptive basics of markdown

Markdown is a lightweight markup language with plain text formatting syntax. It is designed to be easy to read and write, and it can be converted to HTML and other formats. Markdown is widely used for documentation, readme files, and writing content for the web.

Basic Syntax

  1. Headings: Use # for headings. The number of # symbols indicates the level of the heading.

    # Heading 1 ## Heading 2 ### Heading 3
  2. Paragraphs: Simply write text separated by one or more blank lines.

    This is a paragraph. This is another paragraph.
  3. Emphasis:

    • Italic: Use * or _ around the text.

      *italic* or _italic_
    • Bold: Use ** or __ around the text.

      **bold** or __bold__
    • Bold and Italic: Use *** or ___ around the text.

      ***bold and italic*** or ___bold and italic___
  4. Lists:

    • Unordered Lists: Use *, -, or + followed by a space.

      * Item 1 * Item 2 * Subitem 1 * Subitem 2
    • Ordered Lists: Use numbers followed by a period.

      1. Item 1 2. Item 2 1. Subitem 1 2. Subitem 2
  5. Links: Use [text](URL) for inline links.

    [GitHub](https://github.com)
  6. Images: Use ![alt text](URL) for images.

    ![Logo](https://github.com/logo.png)
  7. Blockquotes: Use > followed by a space.

    > This is a blockquote.
  8. Code:

    • Inline Code: Use backticks ` around the code.

      `inline code`
    • Code Blocks: Use triple backticks ``` or indent with four spaces.

    ``` code block ```
  9. Horizontal Rules: Use three or more -, *, or _ on a line by themselves.

    ---
  10. Tables: Use pipes | and hyphens - to create tables.

    | Header 1 | Header 2 | |----------|----------| | Row 1 | Data 1 | | Row 2 | Data 2 |

Advanced Features

  1. Task Lists: Use - [ ] for unchecked and - [x] for checked items.

    - [ ] Task 1 - [x] Task 2
  2. Footnotes: Use [^1] to create footnotes.

    Here is a footnote reference[^1]. [^1]: This is the footnote.
  3. Strikethrough: Use ~~ around the text.

    ~~strikethrough~~

Markdown is versatile and can be extended with various plugins and tools to add more functionality, such as syntax highlighting for code blocks, diagrams, and more.

Last modified: 26 November 2024