Alleviivaus Markdownissa: mikä toimii GitHubissa ja muissa renderöijissä

Markdownissa ei ole sisäänrakennettua syntaksia tekstin alleviivaamiseen. CommonMarkissa ja GitHub Flavored Markdownissa _teksti_ tarkoittaa kursivointia ja __teksti__ lihavointia. Alleviivaus vaatii yleensä HTML-tuen tai sovelluskohtaisen laajennuksen.

GitHubissa dokumentoitu muoto on:

<ins>Muutettu määräaika</ins> on perjantai.

GitHub mainitsee <ins>...</ins>-merkinnän alleviivatulle tekstille perusmuotoilun dokumentaatiossaan. Se on alustan tukema HTML-vaihtoehto, ei uusi Markdown-erotin, joka toimisi kaikkialla.

Alleviivauksen, lihavoinnin ja kursivoinnin vertailu

Lähde	Merkitys	Missä sitä voi odottaa
_tärkeä_	Korostus, tavallisesti kursivointi	CommonMark ja GFM
__tärkeä__	Vahva korostus, tavallisesti lihavointi	CommonMark ja GFM
**tärkeä**	Vahva korostus, tavallisesti lihavointi	CommonMark ja GFM
<ins>lisätty teksti</ins>	Lisätty teksti, tavallisesti alleviivattu	HTML:n sallivat renderöijät; GitHubin dokumentoima
<u>huomautuksella merkitty teksti</u>	HTML-merkintä, tavallisesti alleviivattu	Tämän HTML-elementin sallivat renderöijät

Valitse lihavointi tai kursivointi, kun tavoitteena on korostus. Esimerkiksi **Palautus perjantaina** toimii README-tiedostossa, muistiinpanossa ja Markdown-viennissä ilman riippuvuutta raaka-HTML:stä.

Mitä eroa ins- ja u-tageilla on?

Tagit voivat näyttää samanlaisilta, mutta niiden merkitys on erilainen.

<ins> esittää asiakirjaan lisättyä tekstiä. Se sopii muutokseen, kuten uuteen vaatimukseen. Selain tavallisesti alleviivaa sen, mutta tyylitiedosto voi muuttaa ulkoasua. Katso MDN:n lisätyn tekstin viite.

Versio tukee <ins>CSV- ja TSV-tuonteja</ins>.

<u> merkitsee huomautusta, joka ei ole tavallista korostusta, kuten kirjoitusvirheen osoittamista. Nykyaikainen HTML ei määrittele sitä yleiseksi ”tee tästä tärkeä” -tagiksi. Katso MDN:n u-elementin viite.

Tarkista sanan <u>enään</u> oikeinkirjoitus.

Jos hallitset verkkosivustoa ja tarvitset puhtaasti visuaalisen alleviivauksen, käytä CSS:ssä text-decoration: underline -määritystä. Ylläpidetty Markdown-alusta voi poistaa tyyliattribuutit tai estää mukautetut tyylit, joten tämäkään menetelmä ei ole siirrettävä.

Miksi alleviivaus toimii yhdessä editorissa mutta katoaa toisessa?

Päätöksiä on kolme: Markdown-jäsennin tunnistaa HTML:n, sovellus valitsee sallitut tagit ja kohteen tyylitiedosto määrää sallittujen elementtien ulkoasun. GFM-tuki ei takaa, että tuote sallii kaikki HTML-tagit.

MD File Viewer -editori poistaa tällä hetkellä raaka-HTML-tagit käyttäjän syötteestä. Kun liität sinne <ins>lisätty teksti</ins> tai <u>huomautuksella merkitty teksti</u>, sanat jäävät ilman tageja, joten esikatselu ei alleviivaa niitä. Käytä esikatselua tuettuun Markdown-muotoiluun ja tarkista HTML-pohjainen muotoilu siinä kohteessa, jossa se julkaistaan.

Jos siirrät HTML-asiakirjaa Markdowniin, HTML Markdowniksi -muunnin auttaa palauttamaan tekstin, otsikot, linkit ja luettelot. Alleviivaus ja mukautettu CSS voivat kadota, koska tavallisessa Markdownissa ei ole vastaavaa syntaksia. Tarkista tulos ennen alkuperäisen asiakirjan korvaamista.

Esimerkkejä GitHubin README-tiedostoon

GitHubin dokumentoitu HTML-vaihtoehto lyhyeen lisäykseen muutosmerkinnässä on:

Tämä versio lisää <ins>valinnaisen tuontivaiheen</ins>.

Käytä määräaikaan tai vaatimukseen Markdown-korostusta:

**Pakollinen:** Sisällytä otsikkorivi CSV-tiedostoon.

Käytä kohteeseen linkkiä:

[Lue tuontiohjeet](https://example.com/import)

Alleviivattu teksti voi näyttää napsautettavalta linkiltä. Vältä tekemästä tavallisista nimikkeistä vuorovaikutteisen näköisiä, etenkin jos samassa kappaleessa on oikeita linkkejä. Markdown-linkkien opas käsittelee kuvaavia linkkitekstejä ja viitelinkkejä.

Yleiset alleviivausvirheet

Kaksinkertaiset alaviivat lihavoivat tekstin. Vaihtaminen muodosta **sana** muotoon __sana__ muuttaa erotinta, ei merkitystä. Molemmat edustavat vahvaa korostusta.

Gravismerkit näyttävät tagin koodina. Merkintä `<ins>teksti</ins>` on hyödyllinen oppaassa, mutta se näyttää tarkoituksella merkintäkielen renderöimisen sijaan.

Pikanäppäimet kuuluvat sovellukseen. Muotoillun tekstin editori voi tarjota alleviivauskomennon ja tallentaa HTML:ää tai omaa asiakirjamuotoaan. Se ei tee alleviivauksesta osaa siirrettävää Markdownia.

Alleviivattu otsikko on eri käsite. Tässä lähteessä yhdysmerkit luovat toisen tason otsikon:

Julkaisutiedot
-------------

Ne eivät alleviivaa ilmaisua kappaleen sisällä. Käytä osioiden väliseen erottimeen Markdown-vaakaviivaa, jonka ympärillä on tyhjät rivit.

Usein kysytyt kysymykset

Miten alleviivaan Markdownissa GitHubissa?

Käytä <ins>teksti</ins>-merkintää, jonka GitHub dokumentoi alleviivausta varten. Jos tarvitset myös HTML-tukea vailla olevissa renderöijissä toimivaa korostusta, käytä **teksti** tai *teksti*.

Onko pelkkään Markdowniin perustuvaa alleviivausvaihtoehtoa?

Alleviivaukselle ei ole vakioerotinta. Jotkin sovellukset lisäävät oman syntaksinsa, mutta niiden dokumentaatio ja viennissä käytettävä muoto on tarkistettava.

Säilyykö alleviivaus Markdownin PDF- tai Word-muunnoksessa?

Vain jos muunnin säilyttää asianomaisen HTML:n tai laajennuksen ja tukee sen tyylejä. Älä oleta yhden sovelluksen esikatselussa näkyvän alleviivauksen säilyvän toisen vientityökalun kautta. Tarkista tulostiedosto tai käytä tavallista lihavointia, kun siirrettävyys on tärkeää.

Markdown-muistilista tarjoaa tiiviin viitteen muotoiluille, joilla on oma Markdown-syntaksi.