Markdown-pikaopas

Agenda ei ole Markdown-editori, mutta se tunnistaa osan Markdown-syntaksista tyylien käyttämiseen. Tässä ovat Markdown-oikotiet, joita voit käyttää.

Kappaletyylit

Seuraavat tyylit muuttavat koko kappaleen ulkoasua.

Otsikko

Kirjoita rivin alkuun 1–6 risuaitaa ja välilyönti. Otsikon taso määräytyy risuaitojen määrän mukaan. Esim. ### Esimerkki tuottaa kolmannen tason otsikon.

Viiva- tai luettelomerkitty luettelo

Aloita rivi luettelomerkillä, yhdysmerkillä, tähdellä tai plusmerkillä, niin saat viivoitetun luettelon kohdan. Esim. • Esimerkkikohta 1 - Esimerkkikohta 2 * Esimerkkikohta 3 + Esimerkkikohta 4 tuottaa viiva- tai luettelomerkityn luettelon kohdan.

Numeroitu luettelo

Aloita rivi numerolla, jota seuraa piste ja välilyönti, niin saat numeroidun luettelon kohdan. Esim. \1. Esimerkkikohta 1 tuottaa numeroidun luettelon kohdan.

Jos haluat aloittaa numeroidun luettelon muusta numerosta kuin 1, käytä yksinkertaisesti kyseistä numeroa Esim. \3. Esimerkkikohta 3 tuottaa numeroidun luettelon kohdan, joka alkaa numerosta 3.

Tarkistuslista

Aloita rivi yhdysmerkillä, jota seuraavat avaava ja sulkeva hakasulje. Kun lisäät hakasulkeiden väliin ”x”:n, saat rastitetun kohdan. Esim. - [ ] Esimerkki tuottaa tarkistuslistan kohdan.

- [x] Esimerkki tuottaa rastitetun kohdan.

Yhdysmerkki on valinnainen, joten voit luoda valintaruudun myös pelkillä kahdella hakasulkeella.

Esimuotoiltu

Sisällölle, joka toimii parhaiten tasalevyisellä fontilla, kuten tietokonekoodille, voit käyttää esimuotoiltua tyyliä. Saat tämän tyylin käyttöön aloittamalla rivin kolmella gravis-merkillä. Esim. ```sample tuottaa sample

Koodi

Agenda tukee tietokonekoodin syntaksiväritystä. Lisäämällä kielen nimen kolmen gravis-merkin perään voit ilmoittaa, millä kielellä koodikatkelma on kirjoitettu. Esim. ```swift int i = 0; tuottaa int i = 0 Swift-kielen mukaan väritettynä

Täydellistä luetteloa kaikista tuetuista kieliparametreista ylläpitää highlight.js-projekti osoitteessa https://github.com/highlightjs/highlight.js/blob/main/SUPPORTED_LANGUAGES.md.

Lohkolainaus

Kirjoita rivin alkuun yksi tai useampi >-merkki ja välilyönti. >-merkkien määrä määrää lainauksen tason, jonka osoittavat tekstin edessä olevat pystyviivat. Esim. > Esimerkki tuottaa

Esimerkki

Tekstinsisäiset tyylit

Näitä tyylejä käytetään kappaleiden sisällä tekstin ulkoasun muuttamiseen.

Kursiivi

Alaviivojen tai tähtien väliin kirjoitettu teksti kursivoidaan. Esim. _sample_ tai *sample* tuottaa sample

Lihavointi

Kaksoisalaviivojen tai kaksoistähtien väliin kirjoitettu teksti lihavoidaan. Esim. __sample__ tai **sample** tuottaa sample

Yliviivaus

Kaksoistildejen väliin kirjoitettu teksti yliviivataan. Esim. ~~sample~~ tuottaa sample

Tasalevyinen

Joillekin sisällöille, kuten tietokoneen lähdekoodille, tasalevyinen teksti on parempi. Tekstilohkoille kannattaa käyttää Esimuotoiltu-kappaletyyliä. Tekstin sisällä voit kirjoittaa tekstin gravis-merkkien väliin. Esim. `sample` tuottaa sample

Korostus

Kaksoisyhtäsuuruusmerkkien tai kaksoispisteiden väliin kirjoitettu teksti korostetaan. Esim. ==sample== tai ::sample:: korostaa sanan sample

Lisää

Jotkin tyylit eivät liity tekstin merkitykseen, vaan niillä erotellaan tietoelementtejä, kuten tunnisteita. Myös niitä voi kirjoittaa Markdownin kaltaisella syntaksilla.

Tunnisteet

Kirjoita tunniste #-merkillä, jota seuraa tunniste. Tunnisteessa ei voi olla välilyöntejä. Esim. Kirjoita #giraffes, niin luot tunnisteen ”giraffes”.

#-merkin kirjoittaminen avaa automaattisen täydennyksen ikkunan, joka auttaa sinua löytämään etsimäsi tunnisteen.

Tunnisteissa voi olla myös sulkeissa parametri. Esimerkiksi #due(12/12/2018). Lisätietoja parametrien täysipainoisesta käytöstä tunnisteissa on luvussa Tunnisteet, henkilöt, tekstitoiminnot ja linkit.

Henkilötunnisteet

Agenda tunnistaa toisen tunnistetyypin, joka on varattu yksittäisille ihmisille (henkilöille). Voit kirjoittaa nimen tai nimikirjaimet viitataksesi ystävään tai kollegaan. Kirjoita vain @-merkki tekstin eteen. Esim. Kirjoita @Tom, niin luot henkilötunnisteen henkilölle nimeltä ”Tom”.

@-merkin kirjoittaminen avaa automaattisen täydennyksen ikkunan, joka auttaa sinua löytämään etsimäsi henkilön.

Emojit

Lisää emoji kirjoittamalla : (kaksoispiste), emojin lyhytnimi ja taas sulkeva :. Esim. Kirjoita :+1:, niin lisäät emojin 👍.

Kaksoispisteen kirjoittaminen avaa automaattisen täydennyksen ikkunan, joka auttaa sinua löytämään etsimäsi emojin.

Vaakaviiva

Jos haluat erottaa muistiinpanojesi osioita visuaalisesti vaakaviivalla, voit tehdä sen kirjoittamalla kolme yhdysmerkkiä peräkkäin ja välilyönnin: Esim. Kirjoita ---, niin luot vaakaviivan.

Vinkki: Jos tuot Markdown-tiedoston, voit jakaa sen Agendassa erillisiksi muistiinpanoiksi samoilla kolmella peräkkäisellä yhdysmerkillä: Esim. Ensimmäinen muistiinpano --- Toinen muistiinpano

Tämä luo kaksi eri muistiinpanoa: ensimmäisen sisältö on ”Ensimmäinen muistiinpano” ja toisen ”Toinen muistiinpano”.

Taulukot

Agendassa voit lisätä muistiinpanoihin taulukoita. Voit luoda niitä nopeasti kirjoittamalla rivin alkuun vähintään kolme pystyviivaa (|) peräkkäin: Esim. Kirjoita |||, niin lisäät taulukon.

Linkit

Linkit tunnistetaan tekstistä automaattisesti, mutta voit lisätä niitä myös Markdown-syntaksilla. Kirjoita näytettävä teksti hakasulkeisiin ja linkin URL-osoite sen perään kaarisulkeisiin. Esim. Kirjoita [Agenda](agenda.com), niin luot tekstiin ”Agenda” liitetyn linkin osoitteeseen agenda.com.

Tekstitoiminnot

Vaikka tekstitoiminnot eivät varsinaisesti kuulu perinteiseen Markdown-syntaksiin, Agendassa voit käynnistää tiettyjä toimintoja kirjoittamalla ensin kenoviivan \ ja sen perään toiminnon.

Esimerkiksi \remind lisää muistiinpanoosi muistutuksen. Toiminnolle voi antaa valinnaisia parametreja, esimerkiksi \remind(today at noon) ajastaa muistutuksen tälle päivälle keskipäivään. Muita yleisiä toimintoja ovat \now, \date ja \time, joilla lisäät kuluvan päivämäärän ja kellonajan.

Täydellisen yleiskatsauksen kaikista toiminnoista löydät luvusta Tekstitoimintojen pikaopas.

Toimintoja voi käyttää myös pohjien paikkamerkkeinä, katso luku Pohjien luominen ja käyttö.

Markdown-tulkinnan estäminen

Vaikka Markdown-oikotiet voivat olla erittäin hyödyllisiä ja nopeita, joskus et ehkä halua, että jotain tunnistetaan Markdowniksi. Voit ohittaa yllä olevat Markdown-merkintäsarjat kirjoittamalla ensin kenoviivan \ ja sen perään sen, mitä tavallisesti kirjoittaisit. Kun painat välilyöntiä, kenoviiva katoaa automaattisesti ja teksti jää sellaiseksi kuin sen kirjoitit. Esimerkiksi \1. Something ei tuota numeroitua luetteloa vaan tekstin 1. Something.

Huomaa, että Markdownia ei koskaan tulkita tekstissä, jolla on Esimuotoiltu-kappaletyyli tai Tasalevyinen-tekstityyli.