Markdown-spiekbriefje

Agenda is geen Markdown-editor, maar herkent wel een deel van de Markdown-syntaxis om stijlen toe te passen. Hier volgen de Markdown-sneltoetsen die je kunt gebruiken.

Alineastijlen

De volgende stijlen veranderen het uiterlijk van de hele alinea.

Kop

Gebruik 1 tot 6 hekjes aan het begin van de regel, gevolgd door een spatie. Het aantal hekjes bepaalt het kopniveau. Bijv. ### Voorbeeld levert een kop van het derde niveau op.

Lijst met streepjes of opsommingstekens

Begin een regel met een opsommingsteken, een koppelteken, een sterretje of een plusteken om een lijstitem met streepje te maken. Bijv. • Voorbeelditem 1 - Voorbeelditem 2 * Voorbeelditem 3 + Voorbeelditem 4 levert een lijstitem met streepje of opsommingsteken op.

Genummerde lijst

Begin een regel met een cijfer gevolgd door een punt en een spatie om een genummerd lijstitem te maken. Bijv. \1. Voorbeelditem 1 levert een genummerd lijstitem op.

Om een genummerde lijst met een ander getal dan 1 te laten beginnen, gebruik je gewoon dat getal Bijv. \3. Voorbeelditem 3 levert een genummerd lijstitem op dat bij 3 begint.

Checklist

Begin een regel met een koppelteken gevolgd door een openende en een sluitende rechte haak. Zet je een “x” tussen de twee haken, dan krijg je een afgevinkt item. Bijv. - [ ] Voorbeeld levert een checklistitem op.

- [x] Voorbeeld levert een afgevinkt item op.

Het koppelteken is optioneel, dus je kunt ook alleen met twee rechte haken een aankruisvakje maken.

Voorgeformatteerd

Voor inhoud die het best tot zijn recht komt in een lettertype met vaste breedte, zoals computercode, kun je de stijl Preformatted toepassen. Je roept die stijl op door de regel met drie accenten te beginnen. Bijv. ```sample levert sample op

Code

Agenda ondersteunt syntaxiskleuring van computercode. Door achter de drie accenten de taal te zetten, geef je aan in welke taal het codefragment is geschreven. Bijv. ```swift int i = 0; levert int i = 0 op, gekleurd volgens de taal Swift

Een volledige lijst met alle ondersteunde taalparameters wordt bijgehouden door het project highlight.js op https://github.com/highlightjs/highlight.js/blob/main/SUPPORTED_LANGUAGES.md.

Citaatblok

Gebruik een of meer >-symbolen aan het begin van de regel, gevolgd door een spatie. Het aantal >-tekens bepaalt het citaatniveau, aangegeven door de verticale lijnen vóór de tekst. Bijv. > Voorbeeld levert

Voorbeeld

Inline stijlen

Deze stijlen gebruik je binnen alinea’s om het uiterlijk van tekst te veranderen.

Cursief

Tussen liggende streepjes of sterretjes zetten levert cursieve opmaak op. Bijv. _voorbeeld_ of *voorbeeld* levert voorbeeld op

Vet

Tussen dubbele liggende streepjes of dubbele sterretjes zetten levert vette opmaak op. Bijv. __voorbeeld__ of **voorbeeld** levert voorbeeld op

Doorhalen

Tussen dubbele tildes zetten levert doorgehaalde opmaak op. Bijv. ~~voorbeeld~~ levert ~~voorbeeld~~ op

Vaste breedte (monospaced)

Voor bepaalde inhoud, zoals broncode, is tekst met vaste breedte prettiger. Voor blokken tekst kun je het best de alineastijl Preformatted gebruiken. Voor tekst in de regel kun je die tussen accenten zetten. Bijv. `voorbeeld` levert voorbeeld op

Markeren

Tussen dubbele isgelijktekens of dubbele punten zetten levert markering op. Bijv. ==voorbeeld== of ::voorbeeld:: markeert het woord voorbeeld

Invoegen

Sommige stijlen hebben niets met de betekenis van de tekst te maken, maar bakenen informatieve elementen als tags af. Die kun je ook met een Markdown-achtige syntaxis invoeren.

Persoontags

Agenda kent een tweede soort tag die is voorbehouden aan personen. Je kunt een naam of initialen invoeren om naar een vriend of collega te verwijzen. Zet gewoon een @-symbool voor de tekst. Bijv. Voer @Tom in om een persoontag te maken voor iemand die “Tom” heet.

Als je een @ typt, verschijnt de aanvulpopover die je helpt de persoon te vinden die je zoekt.

Emoji

Om een emoji in te voeren typ je gewoon een : (dubbele punt), gevolgd door de afkorting van de emoji en weer een afsluitende :. Bijv. Typ :+1: om de emoji 👍 in te voegen.

Als je een : typt, verschijnt de aanvulpopover die je helpt de emoji te vinden die je zoekt.

Horizontale lijn

Wil je delen binnen je notities visueel afbakenen met een horizontale lijn, dan kan dat door drie streepjes achter elkaar te typen gevolgd door een spatie: Bijv. Voer --- in om een horizontale lijn te maken.

Tip: Ben je een Markdown-bestand aan het importeren, dan kun je het met diezelfde drie streepjes achter elkaar in afzonderlijke notities in Agenda laten splitsen: Bijv. Eerste notitie --- Tweede notitie

Dat levert twee verschillende notities op, de eerste met de inhoud “Eerste notitie” en de tweede met de inhoud “Tweede notitie”.

Tabellen

Met Agenda kun je tabellen in je notities invoegen; die maak je snel door aan het begin van de regel drie of meer pijpsymbolen (|) achter elkaar te typen: Bijv. Voer ||| in om een tabel in te voegen.

Links

Links worden automatisch in de tekst herkend, maar je kunt ze ook met Markdown-syntaxis toevoegen. Zet de tekst die wordt weergegeven tussen rechte haken, gevolgd door de URL van de link tussen ronde haakjes. Bijv. Voer [Agenda](agenda.com) in om een link naar agenda.com aan de tekst “Agenda” te koppelen.

Tekstacties

Hoewel het strikt genomen geen onderdeel van klassieke Markdown-syntaxis is, kun je in Agenda bepaalde acties starten door eerst een backslash \ te typen, gevolgd door een actie.

Zo voegt \remind een herinnering in je notitie in. Als onderdeel van de actie kun je optionele parameters meegeven; \remind(today at noon) plant bijvoorbeeld een herinnering in voor vandaag om twaalf uur ’s middags. Andere veelgebruikte acties zijn \now, \date en \time, om de huidige datum en tijd in te voegen.

Voor een volledig overzicht van alle acties, zie het hoofdstuk Spiekbriefje tekstacties.

Acties kun je ook als plaatshouders in sjablonen gebruiken, zie het hoofdstuk Sjablonen maken en gebruiken.

Markdown-verwerking voorkomen

Hoewel de Markdown-sneltoetsen supernuttig en snel kunnen zijn, wil je soms niet dat iets als Markdown wordt herkend. Je kunt de bovenstaande Markdown-reeksen omzeilen door eerst een backslash \ te typen, gevolgd door wat je normaal zou typen. Zodra je op de spatiebalk drukt, hoort de backslash automatisch te verdwijnen en blijft de tekst staan zoals je hem typte. Typ je bijvoorbeeld \1. Iets, dan levert dat geen genummerde lijst op maar de tekst 1. Iets.

Let op: binnen tekst met de alineastijl Preformatted en de inline stijl Fixed Width wordt Markdown nooit verwerkt.