Skip to content

example.md

Latest commit

 

History

History
164 lines (108 loc) · 3.8 KB

example.md

File metadata and controls

164 lines (108 loc) · 3.8 KB
title Markdown Docs Example
author Jonny Asmar
description A comprehensive example showcasing the features of the Markdown Docs VS Code extension.
version 1.2.26

Markdown Docs: Example Document

This comprehensive example demonstrates the powerful features of the Markdown Docs VS Code extension. It showcases various Markdown elements enhanced by the extension's capabilities, providing a hands-on exploration of editing, commenting, searching, and formatting features in action.

🚀 Key Features in Action

✍️ WYSIWYG Editing Experience

With Markdown Docs, you get a seamless What You See Is What You Get (WYSIWYG) editing experience. No more switching between raw Markdown and a preview pane! Edit directly and see your changes instantly.

💬 Interactive Commenting

This extension allows you to add comments directly within your Markdown files as custom Markdown directives. Imagine leaving feedback for an AI model, annotating your personal notes, or collaborating with a team. Comments appear in a dedicated sidebar for easy navigation and focus.

🔍 Highlighted Search

Easily find content within your document with the built-in highlighted search functionality. Type your query, and see matches highlighted in real-time as you type.

🔠 Customizable Display Font

Tailor your editing environment by changing the display font directly within the editor settings. Choose a font that suits your preference for optimal readability, productivity, and comfort.

Standard Markdown Elements

Headings

Level 4 Heading

Level 5 Heading
Level 6 Heading

Text Formatting

This is a paragraph with some bold text, italic text, and even bold and italic text. You can also highlight code inline, strike through text, create ==highlighted text==, or use links.

Lists

Ordered List

  1. First item
  2. Second item
    1. Nested ordered item
    2. Another nested item
  3. Third item

Unordered List

  • Apple
  • Banana
    • Green banana
    • Yellow banana
  • Cherry

Checkbox List

  • Task completed
  • Task pending
  • Another task

Links

Visit the Google website.

Admonitions

:::note Note :::

:::tip Tip :::

:::danger Danger :::

:::info Info :::

:::caution Caution :::

Code Blocks

function helloWorld() {
  logger.debug('Hello, Markdown Docs!');
}
helloWorld();
def greet(name):
    return f"Hello, {name}!"

print(greet("AI"))

Mermaid

sequenceDiagram
    Alice ->> Bob: Hello Bob, how are you?
    Bob-->>John: How about you John
    Bob--x Alice: I am good thanks!
    Bob-x John: I am good thanks!
    Note right of John: Bob thinks a long<br/>long time, so long<br/>that the text does<br/>not fit on a row.

    Bob-->Alice: Checking with John...
    Alice->John: Yes... John, how are you?
Loading 
graph TD
   A(Coffee machine <br>not working) --> B{Machine has power?}
   B -->|No| H(Plug in and turn on)
   B -->|Yes| C{Out of beans or water?} -->|Yes| G(Refill beans and water)
   C -->|No| D{Filter warning?} -->|Yes| I(Replace or clean filter)
   D -->|No| F(Send for repair)
Loading

Blockquotes

"The only way to do great work is to love what you do."- Steve Jobs

Tables

Header 1 Header 2 Header 3
Row 1 Col 1 Row 1 Col 2 Row 1 Col 3
Row 2 Col 1 Row 2 Col 2 Row 2 Col 3

Images

Here's a screenshot showing the extension in action:

Markdown Docs Screenshot

This example document should provide a good basis for showcasing the Markdown Docs extension in action. Feel free to add comments, modify content, and explore all the features!

Problematic Characters

tag

This<Still>

{{so_does_this}}.