Rédiger en Markdown

Le Markdown convient bien aux notes de recherche, aux rapports et aux premiers brouillons. Oleafly lui offre une barre de mise en forme dédiée et un chemin de compilation Pandoc, avec des fichiers source que vous pouvez utiliser hors de l’application.

Créez un rapport

1. Choisissez Nouveau projet → Utiliser un modèle → Blank Markdown document.
2. Nommez le projet Notes de terrain et ouvrez main.md.
3. Collez cet exemple, puis choisissez Recompiler ou appuyez sur ⌘Enter / Ctrl+Enter.
4. Si Oleafly propose d’installer un moteur nécessaire, terminez cette installation et compilez à nouveau.

main.md

---
title: "Field notes"
author: "Alex Chen"
date: ""
---

# Question

Does the revised procedure reduce measurement time?

## Method

1. Prepare the sample.
2. Repeat the measurement three times.
3. Record the elapsed time.

## Observations

| Run | Time (s) | Note |
| --- | --- | --- |
| 1 | 12 | First pass |
| 2 | 10 | Repeated pass |

The **mean time** will be compared with the baseline.

Le PDF doit comprendre un titre, des titres de section, une liste numérotée et un tableau. Les métadonnées entre la première paire de lignes --- contrôlent le titre et l’auteur du document.

Édition source et visuelle

Le commutateur au début de la barre d’outils a trois modes. Code modifie le Markdown directement. Visuel offre une édition mise en forme pour les titres, les paragraphes, les listes, les liens, les images et les tableaux. Le mode Les deux affiche le source et le texte mis en forme ensemble. Ouvrez son menu pour choisir Empilé ou Fractionner. Les nouveaux projets s’ouvrent en mode Code, et chaque projet retient le mode dans lequel vous l’avez laissé.

Souligné, surlignage, exposant et indice sont des contrôles de mise en forme Pandoc en mode Code. Leurs boutons sont masqués en mode Visuel. Utilisez Code pour travailler avec les métadonnées, la syntaxe de citation ou d’autres constructions du source.

Télécharger le source de l’exemple

Chaque outil de la barre d’outils

Sélectionnez du texte avant de cliquer sur un contrôle de mise en forme. En mode Code, la plupart des outils entourent la sélection ou insèrent un espace réservé. Ouvrez Plus d’options de mise en forme (…) pour atteindre les contrôles qui ne tiennent pas dans la barre.

Code / Visuel

Basculez entre Code, Visuel et Les deux. Le document reste du source Markdown dans tous les modes.

Annuler

Annule la dernière modification. ⌘Z / Ctrl+Z.

Rétablir

Rétablit une modification annulée. ⌘Shift+Z / Ctrl+Shift+Z.

Titre → Titre

Choisissez Titre dans le menu des titres pour insérer # Title. Remplacez le texte du titre par votre propre titre.

Titre → Section

Choisissez Section dans le menu des titres pour insérer ## Section. Remplacez le texte du titre par votre propre titre.

Titre → Sous-section

Choisissez Sous-section dans le menu des titres pour insérer ### Subsection. Remplacez le texte du titre par votre propre titre.

Titre → Sous-sous-section

Choisissez Sous-sous-section dans le menu des titres pour insérer #### Subsubsection. Remplacez le texte du titre par votre propre titre.

Titre → Titre mineur

Choisissez Titre mineur dans le menu des titres pour insérer ##### Minor heading. Remplacez le texte du titre par votre propre titre.

Titre → Titre de paragraphe

Choisissez Titre de paragraphe dans le menu des titres pour insérer ###### Paragraph heading. Remplacez le texte du titre par votre propre titre.

Liste à puces

Démarre une liste non ordonnée. - Item.

Liste numérotée

Démarre une séquence. 1. Item.

Liste de tâches

En mode Code, ajoutez une tâche et changez [ ] en [x] une fois faite. - [ ] Task.

Citation en bloc

Placez une citation sur sa propre ligne. > quoted text.

Gras

Met le texte sélectionné en valeur. **text** ; ⌘B / Ctrl+B.

Italique

Met un terme en valeur. *text* ; ⌘I / Ctrl+I.

Barré

Marque un texte comme remplacé. ~~text~~.

Code en ligne

Met en forme un nom de fichier, une commande ou un identifiant. Du texte encadré par des accents graves.

Souligné

Sélectionnez une expression en mode Code. [text]{.underline}.

Surlignage

Sélectionnez une expression en mode Code. [text]{.mark}.

Exposant

Sélectionnez l’exposant en mode Code. ^text^.

Indice

Sélectionnez l’indice en mode Code. ~text~.

Souligné et surlignage utilisent des attributs Pandoc pour que la mise en forme survive jusqu’au PDF. Utilisez ces contrôles plutôt que d’ajouter des balises HTML brutes au manuscrit.

Insérer un lien

En mode Code : insère [link text](url). Remplacez les deux espaces réservés.

En mode Visuel : ouvre URL du lien. Saisissez l’adresse et appliquez-la à votre sélection. Utilisez Retirer le lien pour garder le texte sans le lien.

Insérer une image

En mode Code : insère ![caption](image-filename). Remplacez le chemin et la légende.

En mode Visuel : ouvre Fichier image. Saisissez un chemin de projet comme figures/plot.png et appliquez-le.

Insérer un tableau

En mode Code : insère trois colonnes, un en-tête et deux lignes de données. Remplacez les noms de colonnes et les cellules.

En mode Visuel : insère un tableau modifiable avec les mêmes dimensions de départ.

Dessiner un diagramme

Ouvre le compositeur de diagrammes en mode Mermaid. Dessinez un organigramme sur le canevas ou modifiez le code Mermaid, puis choisissez Insérer en Mermaid pour l’ajouter au curseur sous forme de bloc de code mermaid délimité. Voir Diagrammes Mermaid.

Analyse du document

Liste les titres, figures, tableaux, équations, étiquettes, citations et à faire du document dans l’ordre du source, chacun relié à sa ligne. Elle lit aussi le titre, les auteurs, les mots-clés, la date et le résumé depuis l’en-tête, et peut les copier pour un formulaire de soumission. Voir Analyse du document.

Réglages du document

Change la classe de document, la taille de page, les colonnes, les marges, la police de corps, la taille de police, la langue, l’interligne et la numérotation des sections. Oleafly écrit vos choix dans l’en-tête YAML que Pandoc lit, et ajoute un bloc d’en-tête si le fichier n’en a pas. Voir Réglages du document.

Infos du projet

En mode Code : affiche les statistiques du projet et de la sélection.

En mode Visuel : affiche les statistiques de la surface d’édition visuelle.

Rechercher

En mode Code : ouvre la recherche du fichier actif avec ⌘F / Ctrl+F.

En mode Visuel : le bouton Rechercher de la barre du source est masqué.

Importez l’image dans l’arborescence de fichiers avant d’y faire référence. Gardez les chemins d’images relatifs au manuscrit, pour que l’archive source fonctionne sur un autre ordinateur.

Équations et blocs de code

Écrivez les maths en ligne comme $x^2$. Mettez une équation hors ligne entre deux paires de signes dollar :

$$
\bar{x} = \frac{1}{n}\sum_{i=1}^{n}x_i
$$

Pour un exemple de code, encadrez le code de triples accents graves et placez son langage après l’accent ouvrant. Ce sont des constructions du source ; la barre d’outils Markdown n’a pas de bouton séparé pour les équations ni pour les blocs de code délimités.

Diagrammes Mermaid

Choisissez Dessiner un diagramme dans la barre d’outils pour créer un organigramme Mermaid dans le compositeur de diagrammes. Insérer en Mermaid l’ajoute sous forme de bloc de code délimité :

```mermaid
flowchart LR
  A[Sample] --> B[Measure]
```

En mode Les deux, le côté mis en forme dessine le bloc comme un diagramme. Un PDF a besoin d’une image ; le compositeur enregistre donc aussi un PNG rendu dans figures/mermaid-<hash>.png, et la compilation place cette image à la place du bloc. Le diagramme apparaît donc aussi dans le PDF compilé. Si vous modifiez le bloc à la main ensuite, le PDF affiche le code jusqu’à ce que vous insériez ou enregistriez à nouveau le diagramme depuis le compositeur. Voir Mermaid dans les documents Markdown.

Citations et bibliographie

Importez ou créez references.bib, ajoutez bibliography: references.bib aux métadonnées YAML, puis citez une clé existante avec [@citation-key]. Pandoc utilise la bibliographie pour produire des citations mises en forme et une liste de références.

Trouver et gérer les références →

Import et export

Pour garder un brouillon existant en Markdown, créez un Blank Markdown document, collez le brouillon dans main.md, puis importez ses images et sa bibliographie. L’import Document Markdown, séparé dans la bibliothèque, convertit pour l’instant un brouillon en LaTeX. Routes d’importation explique les deux chemins.

Compilez pour obtenir un PDF, ou utilisez Exporter pour créer du Word, du HTML, du Typst, du LaTeX ou du texte brut. Utilisez un ZIP de source pour partager le Markdown d’origine et ses ressources. Exporter votre travail couvre la séquence et les vérifications à faire dans le fichier converti.