Aloitus Markdownilla

Mikä on Markdown?

Markdown on kevyt merkintäkieli, jolla voit kirjoittaa muotoiltua tekstiä pelkällä tekstisyntaksilla. Se on suunniteltu helposti luettavaksi ja kirjoitettavaksi – ihanteellinen dokumentaatioon, muistiinpanoihin ja sisällöntuotantoon.

John Gruberin luoma 2004 Markdown on noussut maailman suosituimpien merkintäkielten joukkoon. Sitä käytetään laajasti GitHubissa, Redditissä, Stack Overflowssa ja monissa sisällönhallintajärjestelmissä.

Miksi käyttää Markdownia?

  • Yksinkertaisuus: Kirjoita sisältöä ilman monimutkaisen muotoilun huolia
  • Siirrettävyys: Muunna helposti HTML:ksi, PDF:ksi tai muihin muotoihin
  • Luettavuus: Sisältö on luettavissa jo raakamuodossaan
  • Alustariippumattomuus: Toimii millä tahansa tekstieditorilla tai alustalla
  • Keskittyminen sisältöön: Keskity kirjoittamiseen muotoilun sijaan
  • Laaja tuki: Käytössä lukemattomilla alustoilla ja sovelluksissa
  • Tulevaisuudenkestävyys: Pelkkä teksti varmistaa pitkäaikaisen saatavuuden

Aloita editorillamme

Markdown-editorimme on suunniteltu tekemään Markdownin kirjoittamisesta ja esikatselusta mahdollisimman helppoa:

  1. Avaa editori etusivulla
  2. Aloita kirjoittaminen sisältösi vasempaan paneeliin
  3. Katso live-esikatselu oikeassa paneelissa
  4. Käytä työkaluriviä nopeaan muotoiluun ilman syntaksin ulkoa opettelemista
  5. Tallenna työ automaattisesti paikalliseen tallennustilaan
  6. Vie sisältö Markdown-tiedostoina

Editorin ominaisuudet

  • Jaettu näkymä: Muokkaa ja esikatse sisältöä samanaikaisesti
  • Syntaksin korostus: Tekee Markdown-koodista helpommin luettavaa
  • Tiedostojen hallinta: Luo, muokkaa ja järjestele useita dokumentteja
  • Automaattinen tallennus: Älä koskaan menetä työtä automaattisen tallennuksen ansiosta
  • Pikanäppäimet: Nopeuta työnkulkua pikanäppäimillä
  • Responsiivinen suunnittelu: Toimii tietokoneella, tabletilla ja puhelimella
  • Tumma tila: Vähennä silmien rasitusta illalla työskennellessä

Pikanäppäimet

ToimenpideWindows/LinuxmacOS
LihavoiCtrl+B⌘+B
KursivoiCtrl+I⌘+I
LinkkiCtrl+K⌘+K
KoodiCtrl+`⌘+`
TallennaCtrl+S⌘+S
Vaihda esikatseluCtrl+P⌘+P

Parhaat käytännöt

  • Pidä yksinkertaisena: Käytä yksinkertaisinta syntaksia, joka täyttää muotoilutavoitteet
  • Ole johdonmukainen: Käytä samaa tyyliä koko dokumentissa
  • Käytä otsikoita loogisesti: Luo selkeä hierarkia otsikoillasi
  • Esikatse säännöllisesti: Tarkista dokumentin ulkoasu kirjoittaessasi
  • Opettele pikanäppäimet: Nopeuta työnkulkua
  • Käytä viittauslinkkejä: Dokumenteissa, joissa on paljon linkkejä – käytä viittaustyyliä
  • Lisää rivinvaihtoja: Käytä tyhjiä rivejä kappaleiden ja osien välissä luettavuuden parantamiseksi

Yleisiä käyttötapauksia

Dokumentaatio

Luo selkeää, hyvin jäsenneltyä dokumentaatiota ohjelmistolle, tuotteille tai prosesseille.

  • README-tiedostot
  • API-dokumentaatio
  • Käyttöoppaat
  • Tekniset spesifikaatiot

Muistiinpanot

Ota jäsenneltyjä, muotoiltuja muistiinpanoja, joita on helppo tarkistaa ja jakaa.

  • Kokousmuistiinpanot
  • Opiskelumuistiinpanot
  • Tutkimusmuistiinpanot
  • Projektisuunnittelu

Sisällöntuotanto

Kirjoita blogikirjoituksia, artikkeleita ja muuta sisältöä siistillä muotoilulla.

  • Blogikirjoitukset
  • Artikkelit
  • Uutiskirjeet
  • Oppaat

Seuraavat askeleet

Valmis oppimaan lisää? Tutustu muihin oppaisiimme:

Aloita luominen nyt

Valmis käyttämään uutta Markdown-osaamistasi? Avaa editori ja luo kauniita, hyvin muotoiltuja dokumentteja sekunneissa.

Avaa editori