Pabraukimas Markdown: kas veikia GitHub ir kitose atvaizdavimo priemonėse

Markdown neturi vietinės sintaksės tekstui pabraukti. CommonMark ir GitHub Flavored Markdown formatu _tekstas_ reiškia kursyvą, o __tekstas__ reiškia paryškinimą. Pabraukimui paprastai reikia HTML palaikymo arba konkrečios programos plėtinio.

GitHub dokumentuota forma yra tokia:

<ins>Patikslintas terminas</ins> yra penktadienis.

GitHub nurodo <ins>...</ins> pabrauktam tekstui savo pagrindinio formatavimo dokumentacijoje. Tai platformos palaikoma HTML parinktis, o ne naujas visur veikiantis Markdown skirtukas.

Pabraukimo, paryškinimo ir kursyvo palyginimas

Šaltinis	Reikšmė	Kur tikėtis palaikymo
_svarbu_	Išskyrimas, paprastai kursyvas	CommonMark ir GFM
__svarbu__	Stiprus išskyrimas, paprastai paryškinimas	CommonMark ir GFM
**svarbu**	Stiprus išskyrimas, paprastai paryškinimas	CommonMark ir GFM
<ins>pridėtas tekstas</ins>	Įterptas tekstas, paprastai pabrauktas	HTML palaikančios priemonės; dokumentuota GitHub
<u>anotuotas tekstas</u>	HTML anotacija, paprastai pabraukta	Priemonės, leidžiančios šį HTML elementą

Rinkitės paryškinimą arba kursyvą, kai tikslas yra išskirti tekstą. Pavyzdžiui, **Terminas: penktadienis** išlieka naudingas README, pastaboje ir Markdown eksporte, nepriklausydamas nuo neapdoroto HTML.

Kuo skiriasi ins ir u?

Abi žymos gali atrodyti panašiai, tačiau turi skirtingą reikšmę.

<ins> reiškia į dokumentą įterptą tekstą. Jis tinka pakeitimui, pavyzdžiui, naujai pridėtam reikalavimui. Naršyklė paprastai jį pabraukia, tačiau stilių lapas gali pakeisti išvaizdą. Žr. MDN įterpto teksto aprašą.

Laida palaiko <ins>CSV ir TSV importą</ins>.

<u> žymi anotaciją, kuri nėra įprastas išskyrimas, pavyzdžiui, rašybos klaidos pažymėjimą. Šiuolaikinis HTML jo neapibrėžia kaip bendros paskirties „padaryk svarbų“ žymos. Žr. MDN u elemento aprašą.

Patikrinkite žodžio <u>gryžti</u> rašybą.

Jei valdote svetainę ir reikia tik vizualaus pabraukimo, per CSS pritaikykite text-decoration: underline. Priglobta Markdown platforma gali pašalinti stiliaus atributus arba neleisti pasirinktinių stilių, todėl šis būdas taip pat nėra perkeliamas.

Kodėl pabraukimas veikia vienoje rengyklėje, bet dingsta kitoje?

Tai trys atskiri sprendimai: Markdown analizatorius atpažįsta HTML, programa pasirenka leidžiamas žymas, o paskirties vietos stilių lapas nustato leidžiamų elementų išvaizdą. GFM palaikymas negarantuoja, kad produktas leidžia visas HTML žymas.

MD File Viewer rengyklė šiuo metu pašalina neapdorotas HTML žymas iš naudotojo įvesties. Įklijavus <ins>pridėtas tekstas</ins> arba <u>anotuotas tekstas</u>, lieka žodžiai be šių žymų, todėl peržiūroje jie nebus pabraukti. Šią peržiūrą naudokite palaikomam Markdown formatavimui, o HTML pagrįstą formatavimą patikrinkite paskirties vietoje, kurioje bus publikuojama.

Jei perkeliate HTML dokumentą į Markdown, HTML į Markdown konverteris padeda atkurti tekstą, antraštes, nuorodas ir sąrašus. Pabraukimas ir pasirinktinis CSS gali būti prarasti, nes paprastas Markdown neturi lygiavertės sintaksės. Prieš pakeisdami originalų dokumentą, patikrinkite rezultatą.

GitHub README pavyzdžiai

Trumpam papildymui pakeitimo pastaboje GitHub dokumentuota HTML parinktis yra tokia:

Ši versija prideda <ins>pasirenkamą importavimo žingsnį</ins>.

Terminui ar reikalavimui naudokite Markdown išskyrimą:

**Privaloma:** Į CSV failą įtraukite antraštės eilutę.

Paskirties vietai nurodyti naudokite nuorodą:

[Skaityti importavimo instrukcijas](https://example.com/import)

Pabrauktas tekstas gali atrodyti kaip spustelėjama nuoroda. Venkite įprastiems užrašams suteikti interaktyvumo įspūdį, ypač kai toje pačioje pastraipoje yra tikrų nuorodų. Markdown nuorodų vadove aptariamas aprašomasis nuorodų tekstas ir nuorodos pagal nuorodos žymę.

Dažnos pabraukimo klaidos

Dvigubi pabraukimo ženklai paryškina tekstą. Pakeitus **žodis** į __žodis__, pasikeičia skirtukas, o ne reikšmė. Abu reiškia stiprų išskyrimą.

Atgaliniai apostrofai rodo žymą kaip kodą. Užrašas `<ins>tekstas</ins>` naudingas mokomojoje medžiagoje, tačiau sąmoningai rodo žymėjimą, užuot jį atvaizdavęs.

Klavišų deriniai priklauso programai. Raiškiojo teksto rengyklė gali siūlyti pabraukimo komandą ir saugoti HTML arba savo dokumento formatą. Tai nepaverčia pabraukimo perkeliamo Markdown dalimi.

Pabraukta antraštė yra kita sąvoka. Šiame šaltinyje brūkšneliai sukuria antro lygio antraštę:

Laidos pastabos
-------------

Jie nepabraukia frazės pastraipoje. Skirtukui tarp skyrių naudokite horizontalią Markdown liniją su tuščiomis eilutėmis aplink ją.

Dažnai užduodami klausimai

Kaip pabraukti Markdown tekstą GitHub?

Naudokite <ins>tekstas</ins>, kurį GitHub dokumentuoja pabraukimui. Išskyrimui, veikiančiam ir be HTML palaikymo, naudokite **tekstas** arba *tekstas*.

Ar yra tik Markdown naudojanti pabraukimo alternatyva?

Standartinio pabraukimo skirtuko nėra. Kai kurios programos prideda savo sintaksę, tačiau reikia patikrinti jų dokumentaciją ir eksportuojant naudojamą formatą.

Ar pabraukimas išliks konvertuojant Markdown į PDF arba Word?

Tik jei konverteris išsaugo atitinkamą HTML ar plėtinį ir palaiko jo stilių. Nemanykite, kad vienos programos peržiūroje matomas pabraukimas išliks eksportuojant kita priemone. Patikrinkite gautą failą arba naudokite standartinį paryškinimą, kai svarbus perkeliamumas.

Markdown atmintinė pateikia glaustą formatavimo, turinčio atskirą Markdown sintaksę, aprašą.