Skip to content

features.md

Latest commit

 

History

History
174 lines (123 loc) · 2.91 KB

features.md

File metadata and controls

174 lines (123 loc) · 2.91 KB

Features

Light and Dark modes

Lists

  • Ordered
    1. Item 1
    2. Item 2
  • Unordered
    • Item 1
    • Item 2
  • Tasks
    • Item 1
    • Item 2

Images

wallpants

Tables

Syntax Description
Header Title
Paragraph Text

Code Highlight & Copy to Clipboard Button

Supported languages.

Header Slugs

Jump to #images

Alerts

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.

<details>

Summary

Some content:

echo "hello world"

Footnotes

Here's a simple footnote,1 and here's a longer one.2

LaTeX / Math

Inline math: $E = mc^2$ and $a^2 + b^2 = c^2$

Inline math: $E = mc^2$ and $a^2 + b^2 = c^2$

Block math with $$:

$$
\int_0^\infty e^{-x^2} dx = \frac{\sqrt{\pi}}{2}
$$

$$ \int_0^\infty e^{-x^2} dx = \frac{\sqrt{\pi}}{2} $$

Math code block:

```math
\sum_{n=1}^{\infty} \frac{1}{n^2} = \frac{\pi^2}{6}
```
$$\sum_{n=1}^{\infty} \frac{1}{n^2} = \frac{\pi^2}{6}$$

Note

Consumers must include KaTeX CSS for proper rendering:

<link rel="stylesheet" href="katex/dist/katex.min.css" />

Mermaid

Take a look at how Pantsdown's demo is built for an example setup.

```mermaid
sequenceDiagram
    participant Alice
    participant Bob
    Alice->>John: Hello John, how are you?
    loop Healthcheck
        John->>John: Fight against hypochondria
    end
    Note right of John: Rational thoughts <br/>prevail!
    John-->>Alice: Great!
    John->>Bob: How about you?
    Bob-->>John: Jolly good!
```

sequenceDiagram
    participant Alice
    participant Bob
    Alice->>John: Hello John, how are you?
    loop Healthcheck
        John->>John: Fight against hypochondria
    end
    Note right of John: Rational thoughts <br/>prevail!
    John-->>Alice: Great!
    John->>Bob: How about you?
    Bob-->>John: Jolly good!
Loading

Footnotes

  1. This is the first footnote. ↩

  2. 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. ↩