Skip to content

Latest commit

 

History

History
151 lines (115 loc) · 4.54 KB

TUTORIAL.md

File metadata and controls

151 lines (115 loc) · 4.54 KB

Markdown for Noobs

Welcome to "Markdown for Noobs," a beginner-friendly guide to mastering Markdown—a lightweight markup language that enables you to format plain text with ease. Whether you're crafting documents, creating content for the web, or taking notes, Markdown simplifies the process.

Table of Contents

  1. What Is Markdown?
  2. Why Use Markdown?
  3. Getting Started with Markdown
  4. Basic Syntax
  5. Extended Syntax
  6. Tools and Resources
  7. Practice Exercises
  8. Additional Resources

1. What Is Markdown?

Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents. Created by John Gruber in 2004, Markdown is now one of the world’s most popular markup languages.

2. Why Use Markdown?

Markdown offers several advantages:

  • Simplicity: Its straightforward syntax is easy to learn and use.
  • Portability: Markdown files are plain text, making them compatible across various platforms and devices.
  • Flexibility: You can convert Markdown files to multiple formats, including HTML, PDF, and Word.
  • Readability: Even without rendering, Markdown files are easy to read in their raw form.

3. Getting Started with Markdown

To begin using Markdown:

  1. Choose a Text Editor: You can use any plain text editor, such as Notepad, TextEdit, or more specialized editors like Visual Studio Code or Geany.
  2. Learn the Syntax: Familiarize yourself with Markdown's syntax to format your text effectively.
  3. Practice: Start by creating simple documents to apply what you've learned.

4. Basic Syntax

Here are some fundamental elements of Markdown:

  • Headings: Create headings by starting a line with one or more # symbols, followed by a space. The number of # symbols corresponds to the heading level.

    # Heading Level 1
    ## Heading Level 2
    ### Heading Level 3
  • Bold and Italic Text:

    • Bold: Surround text with double asterisks ** or double underscores __.
      **Bold Text**
      __Bold Text__
    • Italic: Surround text with single asterisks * or single underscores _.
      *Italic Text*
      _Italic Text_
    • Bold and Italic: Use triple asterisks *** or triple underscores ___.
      ***Bold and Italic Text***
      ___Bold and Italic Text___
  • Lists:

    • Ordered List: Use numbers followed by periods.
      1. First item
      2. Second item
      3. Third item
    • Unordered List: Use asterisks *, plus signs +, or hyphens -.
      - Item 1
      - Item 2
      - Item 3
  • Links: Create links by placing the link text in square brackets [] and the URL in parentheses ().

    [OpenAI](https://www.openai.com)
  • Images: Similar to links, but start with an exclamation mark !.

    ![Alt Text](image_url)
  • Blockquotes: Start the line with a greater-than symbol >.

    > This is a blockquote.
  • Code Blocks:

    • Inline Code: Enclose code within backticks `.
      `Inline code`
    • Multiline Code Blocks: Use triple backticks before and after the code block.
      def hello_world(): print("Hello, world!")

For a comprehensive guide to Markdown's basic syntax, refer to the Markdown Guide.

5. Extended Syntax

Beyond the basics, Markdown supports extended syntax for additional formatting:

  • Tables:

    | Syntax    | Description |
    |-----------|-------------|
    | Header    | Title       |
    | Paragraph | Text        |
  • Footnotes:

    Here's a sentence with a footnote. [^1]
    
    [^1]: This is the footnote.
  • Strikethrough: Use double tildes ~~.

    ~~This text is struck through.~~
  • Task Lists:

    - [x] Completed task
    - [ ] Incomplete task

Note that some extended syntax elements may not be supported in all Markdown applications.

6. Tools and Resources

To enhance your Markdown experience, consider exploring the following tools:

  • Editors:
    • Visual Studio Code: A versatile code editor with Markdown support.
    • Geany: A simple lightweight IDE based on the GTK+ framework.