Markdown

Juicer s’appuie sur io.github.edadma/markdown — un analyseur CommonMark 0.31.2 complet. Chaque page reçoit les mêmes valeurs par défaut ; cette section parcourt ce qui est activé et le rendu de chaque élément.

CommonMark — les bases

Toute la spécification CommonMark fonctionne sans aucune activation. Titres, paragraphes, listes, citations, code en ligne, blocs de code clôturés, liens, images.

# Heading 1
## Heading 2
### Heading 3

A *paragraph* with **strong** emphasis and `inline code`.

> A blockquote.
> Lazy continuation works too.

1. Ordered list
2. With items
   1. Nested
3. Continues

[Link text](https://juicer.build/) and ![alt](https://placehold.co/40x40 "title").

Extras GFM

La configuration de juicer active chaque extension GitHub-Flavored-Markdown que l’analyseur prend en charge :

Tableaux

| Tier | What's in it |
|------|--------------|
| 1 | site.pages, page URLs, drafts, sitemap, summary |
| 2 | live reload, render hooks, RSS, sections, i18n, themes |

se rend comme

Texte barré

~~old behavior~~ se rend comme old behavior.

Listes de tâches

- [x] Tier 1 — done
- [x] Section list pages
- [ ] i18n
- [ ] Render hooks

se rend comme

• Tier 1 — done
• Section list pages
• i18n
• Render hooks

Notes de bas de page

Vous pouvez glisser une référence de note¹ en milieu de paragraphe et la définir ailleurs.

Liens automatiques

Les URL nues comme https://juicer.build/ sont reconnues et transformées en liens cliquables sans la syntaxe explicite […](…).

Ponctuation intelligente

Les guillemets droits deviennent courbes : “hello” devient « hello », et -- / --- deviennent des tirets demi-cadratin/cadratin — comme ceci.

Liens entre les pages

Un lien relatif se résout par rapport au répertoire du fichier où il est écrit, et un lien qui aboutit sur un autre fichier de contenu devient l’URL de ce fichier sur le site. Écrivez [Patterns](patterns.md) dans content/reference/types.md et il se rend en /reference/patterns/ ; ../library/http.md se rend en /library/http/. Un fragment suit : patterns.md#guards devient /reference/patterns/#guards.

C’est tout l’intérêt d’écrire les liens ainsi : le même fichier est correct lu dans le dépôt, où le lien ouvre le fichier voisin, et lu sur le site, où il ouvre la page rendue.

Un lien vers le fichier d’index d’un répertoire — _index.md, ou ce que nomme folderContent, par exemple README.md — se résout vers l’URL de la section elle-même plutôt que vers une page en dessous, tout comme un lien vers le répertoire lui-même (../library/).

Le reste est laissé tel quel : un lien absolu au site /library/ prend le préfixe de chemin de baseURL et rien de plus, un https://… externe et un mailto: n’appartiennent à personne, et #ancre seul reste une référence dans la page où il est écrit. Un lien relatif vers autre chose qu’une page — une image à côté du fichier, un téléchargement — se résout vers le chemin où ce fichier est publié.

Encadrés (admonitions)

Les encadrés de style GFM — > [!NOTE] / > [!TIP] / > [!WARNING] / > [!IMPORTANT] / > [!CAUTION] — se rendent comme des blocs stylés. Source markdown :

> [!NOTE]
> This is the parser's built-in callout. It produces a styled `<div>` with
> the type baked into a class name.

ID de titre automatiques

Chaque <hN> reçoit un id dérivé de son contenu en texte brut. La table des matières le relit ; les liens profonds fonctionnent d’emblée.

## Hello, world!

devient <h2 id="hello-world">Hello, world!</h2> — regardez le fragment dans votre barre d’adresse si vous cliquez sur un titre de cette page.

Listes de définitions

Apple
: A round fruit, typically red or green.

Orange
: A citrus fruit. Also a color.

se rend comme

Apple

A round fruit, typically red or green.

Orange

A citrus fruit. Also a color.

Émojis

:smile: devient 😄, :rocket: devient 🚀, :tada: devient 🎉 — les points de code Unicode, pas des images.

Blocs de code avec langage

<!DOCTYPE html>
<html>
<head><title>{{ .page.title }}</title></head>
<body>
  <main class="prose">{{ .content }}</main>
</body>
</html>

// Squiggly's Go-template-style syntax compiles down to a small AST.
case class TemplateRenderer(
  partials:   TemplateLoader = _ => None,
  data:       Map[String, Any] = Map.empty,
  functions:  Map[String, TemplateFunction] = Map.empty,
)

# A code block tagged `bash` gets a "BASH" badge and copy button.
sbt 'juicerJVM/run serve -s docs -L'

Le thème juicerdocs ajoute un bouton copier-dans-le-presse-papiers sur chaque <pre> — survolez pour le voir.