Warsaw Dynamics
  • Subscribe with Child Pages
  • Unsubscribe with Child Pages
✓ Subscribed
Advanced search
  • Subscribe with Child Pages
  • Unsubscribe with Child Pages
✓ Subscribed

Markdown macro

Documentation

https://www.markdownguide.org/cheat-sheet/

Description

Markdown is a lightweight markup language with plain-text formatting syntax. It is often used to format readme files, comments in forums, and to create rich text using a simple text editor. Markdown documents can be easily converted to HTML and other formats.

Potential use cases

  • Writing Documentation: Markdown is commonly used for writing documentation for software projects, APIs, and libraries due to its simplicity and readability.

  • Creating Readme Files: Markdown is widely used for creating readme files in GitHub repositories, providing a concise and structured overview of the project.

  • Writing Blog Posts: Many blogging platforms and content management systems support Markdown for writing and formatting blog posts and articles.

  • Taking Notes: Markdown is popular among developers and writers for taking notes and organizing thoughts, thanks to its lightweight syntax and ease of use.

Additional options

Name

Type

Function

Use GitHub Flavored Markdown (GFM)

check

enables markup detection used in GitHub - recommended option

Conform to the original markdown as much as possible. (overrides GFM)

check

keeps markdown markup as raw as possible

Enable GitHub Flavored Markdown footnotes

check

enabled footnotes at the bottom of the document

Enable GitHub Flavored Markdown alerts

check

Enabled colored panels such as warnings, information, success

Examples

# Basic Markup (header 1)
## Text styles (header2)
normal text, *italicized text*, **bold text**, ***bold italicized text***
## Lists
1. First item
2. Second item

- Bullet item 1
- Bullet item 2

- [x] Write a guide
- [ ] Update the website

Alerts example

> [!NOTE]
> Highlights information that users should take into account, even when skimming.

> [!TIP]
> Optional information to help a user be more successful.

> [!IMPORTANT]
> Crucial information necessary for users to succeed.

> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.

> [!CAUTION]
> Negative potential consequences of an action.
About us
Our apps

© Warsaw Dynamics, 2025. All rights reserved.