Markdown-spiekbrief
Agenda is nie ’n markdown-redigeerder nie, maar dit herken wel sommige markdown-sintaksis vir die toepassing van style. Hier is markdown-kortpaaie wat gebruik kan word.
Paragraafstyle
Die volgende style verander die voorkoms van die hele paragraaf.
Opskrif
Gebruik 1-6 hutsteken-simbole aan die begin van die reël, gevolg deur ’n spasie. Die opskrifvlak word deur die aantal hutstekens bepaal. Bv. ### Sample lewer ’n derdevlak-opskrif.
Gestreepte of Kolletjielys
Begin ’n reël met ’n kolletjie, koppelteken, sterretjie of plusteken om ’n streeplysitem te maak. Bv. • Sample Item 1 - Sample Item 2 * Sample Item 3 + Sample Item 4 lewer ’n gestreepte of kolletjielysitem.
Genommerde lys
Begin ’n reël met ’n nommer gevolg deur ’n punt en ’n spasie om ’n genommerde lysitem te maak. Bv. \1. Sample Item 1 lewer ’n genommerde lysitem.
Om ’n genommerde lys by ’n ander nommer as 1 te begin, gebruik eenvoudig daardie nommer Bv. \3. Sample Item 3 lewer ’n genommerde lysitem wat by 3 begin.
Kontrolelys
Begin ’n reël met ’n koppelteken gevolg deur ’n oop vierkantshakie en ’n sluitende vierkantshakie. Deur ’n “x” tussen die twee hakies in te voeg, word ’n afgemerkte item geskep. Bv. - [ ] Sample lewer ’n kontrolelysitem.
- [x] Sample lewer ’n afgemerkte item.
Die koppelteken is opsioneel, so u kan ook ’n merkblokkie skep deur net twee vierkantshakies te gebruik.
Voorgeformatteer
Vir inhoud wat die beste in ’n vastewydte-lettertipe werk, soos rekenaarkode, kan u die voorgeformatteerde styl toepas. U kan hierdie styl aktiveer deur die reël met drie aanhalingsmerkies te begin.
Bv.
```sample lewer sample
Kode
Agenda ondersteun sintaksiskleuring van rekenaarkode. Deur die taal ná die drie aanhalingsmerkies by te voeg, kan u aandui in watter taal die kodefragment geskryf is.
Bv.
```swift int i = 0; lewer int i = 0 gekleur met behulp van die Swift-taal
’n Volledige lys van alle ondersteunde taalparameters word deur die highlight.js-projek onderhou by https://github.com/highlightjs/highlight.js/blob/main/SUPPORTED_LANGUAGES.md.
Blokaanhaling
Gebruik een of meer >-simbole aan die begin van die reël, gevolg deur ’n spasie. Die aantal >-karakters bepaal die aanhalingsvlak, wat deur die vertikale lyne voor die teks aangedui word.
Bv.
> Sample lewer
Sample
Inlyn style
Hierdie style word binne paragrawe gebruik om die voorkoms van teks te verander.
Skuinsdruk
Deur teks tussen onderstrepe of sterretjies te plaas, kry u skuinsdrukstilering. Bv. _sample_ of *sample* lewer sample
Vet
Deur teks tussen dubbele onderstrepe of dubbele sterretjies te plaas, kry u vetdrukstilering. Bv. __sample__ of **sample** lewer sample
Deurhaal
Deur teks tussen dubbele tildes te plaas, kry u deurhaalstilering.
Bv.
~~sample~~ lewer sample
Vaste breedte (Vastewydte)
Vir sommige inhoud, soos rekenaarbronkode, is dit verkieslik om teks van vaste wydte te hê. Vir blokke teks is dit die beste om die Voorgeformatteer-paragraafstyl te gebruik. Vir inlyn teks kan u dit tussen aanhalingsmerkies plaas.
Bv.
`sample` lewer sample
Lig uit
Deur teks tussen dubbele gelykaantekens of dubbelpunte te plaas, kry u uitliggingstilering. Bv. ==sample== of ::sample:: lig die woord sample uit
Voeg in
Sommige style hou nie verband met die betekenis van die teks nie, maar word gebruik om inligtingselemente soos etikette af te baken. Hierdie kan ook met markdown-agtige sintaksis ingevoer word.
Etikette
Om ’n etiket in te voer, gebruik net ’n #-simbool, gevolg deur die etiket. Die etiket kan nie spasies bevat nie.
Bv.
Tik #giraffes om ’n etiket met die naam “giraffes” te skep.
Deur ’n # te tik, word die outovoltooiing-opspringer geaktiveer om u te help om die etiket te vind wat u soek.
Etikette kan ook ’n parameter tussen hakies bevat. Byvoorbeeld, #due(12/12/2018). Om meer te leer oor hoe om ten volle van parameters in etikette gebruik te maak, sien die hoofstuk Tags, People, Text Actions and Links.
Persoonetikette
Agenda herken ’n tweede tipe etiket wat vir individue (mense) gereserveer is. U kan ’n naam of voorletters invoer om na ’n vriend of kollega te verwys. Voer net ’n @-simbool voor die teks in.
Bv.
Voer @Tom in om ’n persoonetiket te skep vir iemand met die naam “Tom”.
Deur ’n @ te tik, word die outovoltooiing-opspringer geaktiveer om u te help om die persoon te vind wat u soek.
Emoji
Om ’n emoji in te voer, tik net ’n : (dubbelpuntkarakter), gevolg deur die kortskrif van die emoji, en weer ’n sluitende :.
Bv.
Tik :+1: om die 👍-emoji in te voeg.
Deur ’n : te tik, word die outovoltooiing-opspringer geaktiveer om u te help om die emoji te vind wat u soek.
Horisontale lyn
As u afdelings binne u notas visueel wil afbaken met ’n horisontale lyn, kan u dit doen deur drie strepies op ’n ry te tik, gevolg deur ’n spasie:
Bv.
Voer --- in om ’n horisontale lyn te skep.
Wenk: As u ’n markdown-lêer invoer, kan u dit in afsonderlike notas in Agenda laat verdeel deur dieselfde drie strepies op ’n ry te gebruik: Bv. Eerste nota
---Tweede notaDit sal twee verskillende notas skep, die eerste met die inhoud “Eerste nota”, en die tweede met die inhoud “Tweede nota”.
Tabelle
Agenda gee u die vermoë om tabelle in u notas in te voeg, wat u vinnig kan skep deur drie of meer pyp-simbole (|) op ’n ry aan die begin van die reël te tik:
Bv.
Voer ||| in om ’n tabel in te voeg.
Skakels
Skakels word outomaties in teks herken, maar u kan hulle ook met markdown-sintaksis byvoeg. Gebruik vierkantshakies om die teks wat gewys word te omsluit, gevolg deur hakies wat die skakel-BA omsluit. Bv. Voer [Agenda](agenda.com) in om ’n skakel na agenda.com te skep wat aan die teks “Agenda” geheg is.
Teksaksies
Hoewel dit nie streng gesproke deel van klassieke markdown-sintaksis is nie, laat Agenda toe dat sekere aksies geaktiveer word as u begin deur ’n rugstreep-simbool \ te tik, gevolg deur ’n aksie.
Byvoorbeeld \remind sal die invoeging van ’n herinnering in u nota aktiveer. Opsionele parameters kan as deel van die aksie verskaf word; byvoorbeeld, \remind(today at noon) sal ’n herinnering vir vandag om twaalfuur skeduleer. Ander algemene aksies is \now, \date, en \time, om die huidige datum en tyd in te voeg.
Vir ’n volledige oorsig van alle aksies, sien die hoofstuk Text Actions Cheat Sheet.
Aksies kan ook as plekhouers in sjablone gebruik word; sien die hoofstuk Creating and Using Templates.
Om markdown-ontleding te voorkom
Hoewel die markdown-kortpaaie uiters nuttig en vinnig kan wees, is daar tye wanneer u dalk nie wil hê dat iets as markdown herken word nie. U kan die bogenoemde markdown-reekse ontsnap deur eers ’n rugstreepkarakter \ te tik, gevolg deur wat u normaalweg sou tik. Wanneer u ’n spasie druk, behoort die rugstreepkarakter outomaties te verdwyn en die teks behoort te bly soos u dit getik het. Byvoorbeeld, deur \1. Something te tik, sal daar nie ’n genommerde lys ontstaan nie, maar die teks 1. Something.
Let daarop dat markdown nooit ontleed word binne teks wat die Voorgeformatteer-paragraafstyl en Vaste breedte-inlynstyl het nie.