Back to Home
    MarkdownMarkdown GFMBeginner

    Markdown

    Markdown syntax for headings, lists, links, images, tables, code blocks, and GitHub Flavored Markdown.

    5 min read
    markdowndocswritinggithub

    Syntax

    2 topics

    Text Formatting

    markdown
    # Heading 1
    ## Heading 2
    ### Heading 3
    
    **bold text**
    *italic text*
    ~~strikethrough~~
    `inline code`
    
    > Blockquote
    > multi-line
    
    ---  (horizontal rule)
    
    [Link text](https://example.com)
    [Link with title](https://example.com "Title")
    ![Alt text](image.png)
    
    Line break: end a line with two spaces  
    or use a blank line for a new paragraph.

    💡 GFM (GitHub Flavored Markdown) adds tables, task lists, and emoji support

    Lists, Tables & Code

    markdown
    # Unordered list
    - Item one
    - Item two
      - Nested item
    
    # Ordered list
    1. First
    2. Second
    3. Third
    
    # Task list (GFM)
    - [x] Completed task
    - [ ] Pending task
    
    # Table
    | Name  | Age | City       |
    |-------|-----|------------|
    | Alice | 30  | New York   |
    | Bob   | 25  | London     |
    
    # Fenced code block
    ```python
    def hello():
        print("Hello!")
    ```

    ⚡ Align table columns with spaces for readability — most editors auto-format

    Related Articles

    Background reading and deeper explanations for this sheet.

    Event-Driven Agents with Kafka Streams: A Practical Guide for Building Real-Time AI Workflows

    Event-driven agents let you move from slow, request/response automation to responsive systems that react in milliseconds to real-world signals. In this hands-on guide, you’ll learn how to design, build, and operate agentic workflows using Apache Kafka and Kafka Streams, with practical patterns, code snippets, and production-ready advice.

    keyword overlap

    GenAI SaaS Architecture: A Practical Blueprint for Building, Scaling, and Securing AI Products

    Designing a SaaS product on top of GenAI is more than calling an LLM API—it requires thoughtful architecture across product, data, safety, and operations. This practical guide walks you through a beginner-friendly yet deep system blueprint, with real-world patterns, code snippets, and deployment strategies you can use immediately.

    keyword overlap

    Intro to FastAPI: Build a Production-Ready Python API with Real Examples

    FastAPI is one of the fastest ways to build modern APIs in Python without sacrificing code quality or developer experience. In this practical, beginner-friendly guide, you’ll learn how to create endpoints, validate data, handle errors, connect a database, secure routes, and prepare your FastAPI app for real-world deployment.

    keyword overlap

    Python Stack vs Heap Memory: A Simple, Practical Guide for Developers

    Confused about where Python stores function calls, variables, and real objects? This guide breaks down stack vs heap memory in plain English, with clear examples showing local references on the stack and actual objects on the heap. You’ll learn how this impacts performance, debugging, and writing cleaner Python code.

    keyword overlap