Jun 12, 2024scipress docs markdown

Markdown

Life's a garden. Dig it.

Posts are written in Markdown - a syntax widely used to write content for the web.

Markdown's key feature is that it's easy to read and write, and the output looks like the input. To illustrate, consider how you might write a recipe for a PB&J sandwichusing HTML.

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Peanut Butter and Jelly Sandwich Recipe</title>
</head>
<body>
    <h1>Peanut Butter and Jelly Sandwich Recipe</h1>
 
    <img src="https://www.food.com/pbj_sandwich.jpg" alt="PB&J" width="500" height="600">
    
    <h2>Ingredients</h2>
    <ul>
        <li>2 slices of bread</li>
        <li>2 tablespoons peanut butter</li>
        <li>2 tablespoons jelly or jam</li>
    </ul>
    
    <h2>Instructions</h2>
    <ol>
        <li>Lay out the two slices of bread on a plate.</li>
        <li>Spread the peanut butter evenly on one slice of bread.</li>
        <li>Spread the jelly or jam evenly on the other slice of bread.</li>
        <li>Press the two slices of bread together with the peanut butter and jelly sides facing each other.</li>
        <li>Cut the sandwich in half if desired.</li>
        <li>Serve immediately and enjoy!</li>
    </ol>
    
    <h2>Tips</h2>
    <p>You can use any type of bread, peanut butter, or jelly according to your preference.</p>
</body>
</html>

Not only is this difficult to write, but output of this code is not immediately obvious. Essentially, you have to render it to see what it looks like.

By contrast, the same thing can be written in Markdown like this 👇

# Peanut Butter and Jelly Sandwich Recipe
 
![PB&J](https://www.food.com/pbj_sandwich.jpg)
 
## Ingredients
- 2 slices of bread
- 2 tablespoons peanut butter
- 2 tablespoons jelly or jam
 
## Instructions
1. Lay out the two slices of bread on a plate.
2. Spread the peanut butter evenly on one slice of bread.
3. Spread the jelly or jam evenly on the other slice of bread.
4. Press the two slices of bread together with the peanut butter and jelly sides facing each other.
5. Cut the sandwich in half if desired.
6. Serve immediately and enjoy!
 
## Tips
You can use any type of bread, peanut butter, or jelly according to your preference.

Scipress Markdown Extensions¶

In addition to standard Markdown features like headers, lists, code blocks, etc., Scipress supports a number of additional features including

Admonitions

I'm an admonition!
Icons

...
Mathematical Formulas

$e^{ix}=\cos x+i!\sin x$
Tailwind CSS

I'm bold, rosy red text with an emerald border.