### Markdown Ordered List Examples Source: https://www.markdownguide.org/basic-syntax Provides examples of creating ordered lists in Markdown using numbers followed by periods. It demonstrates that the numbering does not need to be sequential in the source, but the list should start with '1'. It also shows how to create indented sub-lists. ```markdown 1. First item 2. Second item 3. Third item 4. Fourth item ``` ```markdown 1. First item 1. Second item 1. Third item 1. Fourth item ``` ```markdown 1. First item 8. Second item 3. Third item 5. Fourth item ``` ```markdown 1. First item 2. Second item 3. Third item 1. Indented item 2. Indented item 4. Fourth item ``` -------------------------------- ### Markdown Definition Lists Example Source: https://www.markdownguide.org/extended-syntax Provides an example of creating definition lists in Markdown. Each term is followed by its definition(s), preceded by a colon. ```markdown First Term : This is the definition of the first term. Second Term : This is one definition of the second term. : This is another definition of the second term. ``` -------------------------------- ### Markdown Strikethrough Example Source: https://www.markdownguide.org/extended-syntax Demonstrates how to apply strikethrough formatting to text in Markdown using double tilde symbols. ```markdown ~~The world is flat.~~ We now know that the world is round. ``` -------------------------------- ### Markdown Task Lists Example Source: https://www.markdownguide.org/extended-syntax Illustrates the creation of task lists (checklists) in Markdown. Items can be marked as completed (`[x]`) or pending (`[ ]`). ```markdown - [x] Write the press release - [ ] Update the website - [ ] Contact the media ``` -------------------------------- ### HTML Ordered List Example Source: https://www.markdownguide.org/basic-syntax Shows the HTML equivalent for creating an ordered list with nested items. This is useful for understanding how Markdown renders to HTML and for ensuring compatibility. ```html
  1. First item
  2. Second item
  3. Third item
  4. Fourth item
``` ```html
  1. First item
  2. Second item
  3. Third item
  4. Fourth item
``` ```html
  1. First item
  2. Second item
  3. Third item
  4. Fourth item
``` ```html
  1. First item
  2. Second item
  3. Third item
    1. Indented item
    2. Indented item
  4. Fourth item
``` -------------------------------- ### Markdown Footnotes Example Source: https://www.markdownguide.org/extended-syntax Demonstrates how to create and reference footnotes in Markdown. Footnotes can include multiple paragraphs and code blocks, and are automatically numbered sequentially in the output. ```markdown Here's a simple footnote,[^1] and here's a longer one.[^bignote] [^1]: This is the first footnote. [^bignote]: Here's one with multiple paragraphs and code. Indent paragraphs to include them in the footnote. `{ my code }` Add as many paragraphs as you like. ``` -------------------------------- ### teedoc Tabset Syntax Example Source: https://www.markdownguide.org/tools/teedoc Demonstrates the teedoc syntax for creating tabbed content with different programming language examples. This feature allows for displaying code snippets or content variations within tabs, enhancing documentation clarity. It requires the teedoc Markdown parser and generates HTML for interactive tabs. ```markdown .. tabset:: :id: tabset1 ## Kotlin Content 1, full Markdown syntax support ## Java Content 2, full Markdown syntax support ``` ```html
Title(optional)
Kotlin Java

Content 1, full Markdown syntax support

Content 2, full Markdown syntax support

``` -------------------------------- ### Markdown Basic Syntax Cheat Sheet Source: https://www.markdownguide.org/api/v1 Provides syntax examples for common Markdown elements like blockquotes, bold text, code formatting, headings, images, italics, links, and lists. This is useful for quick reference when writing Markdown. ```json { "element": "Blockquotes", "syntax": "> blockquote" } { "element": "Bold", "syntax": "**bold text**" } { "element": "Code", "syntax": "`code`" } { "element": "Headings", "syntax": "# H1\n## H2\n### H3\n" } { "element": "Horizontal Rules", "syntax": "---" } { "element": "Images", "syntax": "![alt text](image.jpg)" } { "element": "Italic", "syntax": "*italicized text*" } { "element": "Links", "syntax": "[title](https://www.example.com)" } { "element": "Ordered Lists", "syntax": "1. First item\n2. Second item\n3. Third item\n" } { "element": "Unordered Lists", "syntax": "- First item\n- Second item\n- Third item\n" } ``` -------------------------------- ### Markdown Code Block Syntax Source: https://www.markdownguide.org/basic-syntax Demonstrates the creation of multi-line code blocks by indenting each line with at least four spaces or one tab. This preserves whitespace and formatting for code examples. ```markdown ``` -------------------------------- ### Automatic URL Linking in Markdown Source: https://www.markdownguide.org/extended-syntax Demonstrates Markdown's capability to automatically convert URLs into clickable links without requiring explicit formatting like brackets. ```markdown http://www.example.com ``` -------------------------------- ### Markdown Ordered List Syntax Source: https://www.markdownguide.org/basic-syntax Illustrates the creation of ordered lists in Markdown, including the ability to indent and nest unordered lists within ordered ones. Each item in an ordered list starts with a number followed by a period. ```markdown 1. First item 2. Second item 3. Third item - Indented item - Indented item 4. Fourth item ``` -------------------------------- ### Basic Markdown Syntax Examples Source: https://www.markdownguide.org/cheat-sheet Illustrates fundamental Markdown syntax elements for common formatting like headings, emphasis, lists, links, and images. These elements are universally supported across most Markdown processors. ```markdown # H1 ## H2 ### H3 ``` ```markdown **bold text** ``` ```markdown *italicized text* ``` ```markdown > blockquote ``` ```markdown 1. First item 2. Second item 3. Third item ``` ```markdown - First item - Second item - Third item ``` ```markdown `code` ``` ```markdown --- ``` ```markdown [title](https://www.example.com) ``` ```markdown ![alt text](image.jpg) ``` -------------------------------- ### Markdown Heading IDs Example Source: https://www.markdownguide.org/extended-syntax Shows how to add custom IDs to Markdown headings for direct linking and CSS styling. The ID is enclosed in curly braces on the same line as the heading. ```markdown ### My Great Heading {#custom-id} ``` -------------------------------- ### Markdown Table Creation and Formatting Source: https://www.markdownguide.org/extended-syntax Demonstrates how to create and format tables in Markdown using pipes and hyphens. It covers basic table structure, cell alignment using colons, and formatting text within cells, including links and emphasis. Limitations include the inability to use headings, blockquotes, lists, or most HTML tags within cells. ```markdown | Syntax | Description | | ----------- | ----------- | | Header | Title | | Paragraph | Text | ``` ```markdown | Syntax | Description | | --- | ----------- | | Header | Title | | Paragraph | Text | ``` ```markdown | Syntax | Description | Test Text | | : | :----: | ---: | | Header | Title | Here's this | | Paragraph | Text | And more | ``` -------------------------------- ### Markdown Link Example: Standard vs. Reference Style Source: https://www.markdownguide.org/basic-syntax Compares a standard inline link with a reference-style link in Markdown. The reference-style link separates the visible text from the URL and title, which can improve readability. The rendered output is identical for both. ```markdown In a hole in the ground there lived a hobbit. Not a nasty, dirty, wet hole, filled with the ends of worms and an oozy smell, nor yet a dry, bare, sandy hole with nothing in it to sit down on or to eat: it was a [hobbit-hole](https://en.wikipedia.org/wiki/Hobbit#Lifestyle "Hobbit lifestyles"), and that means comfort. In a hole in the ground there lived a hobbit. Not a nasty, dirty, wet hole, filled with the ends of worms and an oozy smell, nor yet a dry, bare, sandy hole with nothing in it to sit down on or to eat: it was a [hobbit-hole][1], and that means comfort. [1]: "Hobbit lifestyles" ``` -------------------------------- ### Markdown Fenced Code Blocks Source: https://www.markdownguide.org/extended-syntax Shows how to create code blocks using fenced syntax (three backticks or tildes) instead of indentation. This method simplifies code inclusion and can be combined with syntax highlighting by specifying the language after the opening fence. ```markdown ``` { "firstName": "John", "lastName": "Smith", "age": 25 } ``` ``` ```markdown ```json { "firstName": "John", "lastName": "Smith", "age": 25 } ``` ``` -------------------------------- ### Create Subscript Text in Markdown using ~ and <sub> Source: https://www.markdownguide.org/extended-syntax Illustrates how to create subscript text. The primary method uses a single tilde (~) before and after the characters. Alternatively, the HTML <sub> tag can be used if HTML is supported. Be cautious as tildes may be interpreted as strikethrough in some applications. ```markdown H~2~O ``` ```html H2O ``` -------------------------------- ### Create Unordered Lists in Markdown Source: https://www.markdownguide.org/basic-syntax Demonstrates the creation of basic unordered lists using '-', '*', or '+' as delimiters. Supports nested lists by indenting items. Ensure consistent delimiter usage within a single list for compatibility. ```markdown - First item - Second item - Third item - Fourth item ``` ```markdown * First item * Second item * Third item * Fourth item ``` ```markdown + First item + Second item + Third item + Fourth item ``` ```markdown - First item - Second item - Third item - Indented item - Indented item - Fourth item ``` -------------------------------- ### Link Image with Markdown Source: https://www.markdownguide.org/basic-syntax This snippet demonstrates how to create a hyperlink for an image using Markdown syntax. It requires the image URL and the desired link URL. The syntax involves enclosing the image Markdown within square brackets and appending the link URL in parentheses. ```markdown [![An old rock in the desert](/assets/images/shiprock.jpg "Shiprock, New Mexico by Beau Rogers")](https://www.flickr.com/photos/beaurogers/31833779864/in/photolist-Qv3rFw-34mt9F-a9Cmfy-5Ha3Zi-9msKdv-o3hgjr-hWpUte-4WMsJ1-KUQ8N-deshUb-vssBD-6CQci6-8AFCiD-zsJWT-nNfsgB-dPDwZJ-bn9JGn-5HtSXY-6CUhAL-a4UTXB-ugPum-KUPSo-fBLNm-6CUmpy-4WMsc9-8a7D3T-83KJev-6CQ2bK-nNusHJ-a78rQH-nw3NvT-7aq2qf-8wwBso-3nNceh-ugSKP-4mh4kh-bbeeqH-a7biME-q3PtTf-brFpgb-cg38zw-bXMZc-nJPELD-f58Lmo-bXMYG-bz8AAi-bxNtNT-bXMYi-bXMY6-bXMYv) ``` -------------------------------- ### Escape Periods in Unordered List Items (Markdown) Source: https://www.markdownguide.org/basic-syntax Illustrates how to prevent a number followed by a period at the start of an unordered list item from being interpreted as an ordered list. Achieved by escaping the period with a backslash. ```markdown - 1968\. A great year! - I think 1969 was second best. ``` -------------------------------- ### Markdown Image Syntax Source: https://www.markdownguide.org/basic-syntax Demonstrates how to include images in Markdown documents using an alt text and a file path. Ensure the image file exists at the specified path for rendering. ```markdown ![Tux, the Linux mascot](/assets/images/tux.png) ``` -------------------------------- ### Markdown API Changelog Source: https://www.markdownguide.org/api/v1 Chronological list of updates made to the Markdown Guide API. It includes dates and descriptions of changes, such as adding new features or updating existing ones. Useful for developers integrating with the API. ```text 2018-10-18 - Updated cheat sheet endpoint to include information about definition lists 2018-07-12 - Updated links description to include information about adding titles 2017-11-10 - Added cheat sheet endpoint 2017-11-04 - Added section about escaping backticks in code 2017-10-24 - Released API v1 - Published docs ``` -------------------------------- ### HTML for Markdown Definition Lists Source: https://www.markdownguide.org/extended-syntax Displays the HTML structure for Markdown definition lists. It uses `
`, `
`, and `
` tags to represent the list, terms, and definitions, respectively. ```html
First Term
This is the definition of the first term.
Second Term
This is one definition of the second term.
This is another definition of the second term.
``` -------------------------------- ### Disable Automatic URL Linking in Markdown using Backticks Source: https://www.markdownguide.org/extended-syntax Shows how to prevent a URL from being automatically converted into a link by enclosing it within backticks. This treats the URL as literal code. ```markdown `http://www.example.com` ``` -------------------------------- ### Basic Syntax API Endpoint Source: https://www.markdownguide.org/api/v1 Retrieves documentation about basic Markdown elements as outlined in John Gruber's design document. ```APIDOC ## GET /api/v1/basic-syntax.json ### Description This endpoint provides documentation on essential Markdown elements, including those described on the Basic Syntax page of the Markdown Guide. ### Method GET ### Endpoint /api/v1/basic-syntax.json ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```bash curl https://www.markdownguide.org/api/v1/basic-syntax.json ``` ### Response #### Success Response (200) - **data** (object) - Contains detailed Markdown syntax information. #### Response Example ```json { "data": { "headings": [ { "id": "headings", "name": "Headings", "content": "# Heading 1\n## Heading 2\n..." } ], "paragraphs": { "id": "paragraphs", "name": "Paragraphs", "content": "Paragraphs are separated by a blank line." } // ... other Markdown elements } } ``` ``` -------------------------------- ### HTML for Markdown Heading IDs Source: https://www.markdownguide.org/extended-syntax Illustrates the HTML output generated from Markdown headings with custom IDs. The custom ID is used as the 'id' attribute for the HTML heading tag. ```html

My Great Heading

``` -------------------------------- ### Markdown Basic Link Syntax Source: https://www.markdownguide.org/basic-syntax Shows the standard method for creating hyperlinks in Markdown. It involves enclosing the link text in square brackets and the URL in parentheses immediately following. ```markdown My favorite search engine is [Duck Duck Go](https://duckduckgo.com). ``` -------------------------------- ### Markdown URL and Email Link Syntax Source: https://www.markdownguide.org/basic-syntax Explains how to automatically convert URLs and email addresses into clickable links by enclosing them in angle brackets. This is a shorthand for creating basic links. ```markdown ```