Satura rādītājs
Kas ir MarkdownTas ir definēts tikpat daudz kā programmatūra, kas rakstīta Perl, kas pārvērš HTML rakstīto tekstu un papildus sintaksi, ko izmanto, lai sasniegtu gaidīto HTML rezultātu. Sintakse, kas izstrādāta, lai būtu vienkārša ikvienam, kas vēlas rakstīt tīmeklī, par to nav jāzina.
Mūsdienās lielākā daļa satura pārvaldnieku un pat daudzi pasta klienti sākotnēji atbalsta Markdown sintakses izmantošanu ar nolūku atvieglot formatēta teksta izveidi bez nepieciešamības ieviest stilus vai zināt HTML. Šie apstrādātāji izmanto parsētāju, lai Markdown tekstu pārvērstu HTML.
MarkDown un dokumentācija
Ir ļoti noderīgi apgūt daudzus dokumentācijas rīkus no atzīmes; wikia, onenote, evernote, alfresco to atbalsta sākotnēji vai ar trešo pušu palīdzību. Ir svarīgi, lai būtu dokumentācija par procesiem un iespējamām problēmām, bet vēl svarīgāk ir saglabāt to kārtīgu un tīru pat no konsoles, un marķējums ir šeit, lai mums palīdzētu.
Punkti
Ja mēs parasti rakstītu kopējā redaktorā, lai definētu rindkopu, mēs vienkārši nospiedīsim pāris:
Ievadiet
Un mēs redzēsim, ka mūsu kursors iet pāris rindiņas zemāk, lai rakstītu jaunā rindkopā.HTML tas ir pazīstams kā punktu.
Markdown tas ir tikpat vienkārši kā parastajā redaktorā.
Turklāt mums ir priekšrocība, ka vienas rindiņas pārtraukums neatdala tekstu vairākās rindās, ja mēs rakstām kaut ko līdzīgu:
Teksts. Cits teksts.Tas izskatīsies šādi:
Teksts. Cits teksts.Izmantojot vairākas atdalītāju līnijas, starp rindkopām tiek samazināts līdz vienam atdalītājam
Galvenes
Parastā redaktorā mums būtu nepieciešama rīkjosla, lai definētu teksta virsraksta stilu, vai, ja jūtaties mazliet netīrs, pietiek ar fonta lieluma palielināšanu un treknrakstu.
HTML tie ir pazīstami kā
,
utt., no galvenes.
Markdown programmā tas ir ļoti vienkārši, jums vienkārši jāievieto ciparu rakstzīme (#) kā galvenes prefikss, jo vairāk no tiem ir ar zemāku grādu, bet galvene būs ne vairāk kā 6.
Piemēram, galvene (lielākais) un viens tie būtu rakstīti šādi:
# Liela galvene ### Maza galvene
un rezultāts būs šāds.
Markdown programmā tas ir ļoti vienkārši, jums vienkārši jāievieto ciparu rakstzīme (#) kā galvenes prefikss, jo vairāk no tiem ir ar zemāku grādu, bet galvene būs ne vairāk kā 6.
Piemēram, galvene (lielākais) un viens tie būtu rakstīti šādi:
# Liela galvene ### Maza galveneun rezultāts būs šāds.
Lielisks galvene
Maza galvene
Atdalītājus parasti nav iespējams izdarīt vienkāršos redaktoros.
PALIELINĀT
Tos norobežo, ierakstot 3 vai vairāk zvaigznītes vai defises. Tiem var sekot vai atdalīties ar atstarpi, tas ir vienaldzīgi.
* * * *** - - - ---Uzsvars
Šis formatējums ir pazīstams kā slīpraksts un treknraksts.
HTML tas būtu Y .
Lai izveidotu tekstu slīprakstā, teksts vienkārši jāapņem starp zvaigznītēm vai pasvītrojumiem, bet treknrakstā - starp dubultspēlēm:
* kursīvs teksts. * _ slīpraksts Teksts. ** ** treknrakstā. ** __bold teksts .__Tas izskatītos apmēram šādi:
slīpraksts. drosmīgs teksts.
Pārsvītrojums
Tas ļauj ievietot tekstu tā, it kā mēs to izsvītrotu, daudz izmantotu versiju kontrolei. o Kļūdas, kas tika labotas lietojumprogrammā vai sistēmā.
HTML gadījumā tas būtu no pārsvītrojuma.
Pietiek, lai tekstu ievietotu starp dubultiem lielajiem burtiem vai tildēm:
~ ~ pārsvītrots teksts. ~~Šī opcija nav standarta un var nedarboties visos redaktoros.
Citāti
Citēšanas stilu parasti nav viegli atrast parastajā teksta redaktorā
HTML tas būtu
.
Mums vienkārši jāievieto rakstzīme "lielāks par" (>) kā teksta prefikss (līdzīgi kā adresēšanai Linux)> Šis ir citāts.Tas izskatītos šādi:Šis ir citāts.
Saraksti
Lai definētu mērķu sarakstu, mēs parasti izmantojam aizzīmju funkcionalitāti sarakstiem bez īpašas secības un numurētiem sarakstiem.
HTML tas būtu nesakārtotiem sarakstiem, pasūtītajiem sarakstiem un lai definētu katru saraksta vienumu.
Markdown mēs tos definējam, vienkārši pievienojot katram vienumam zvaigznīti (*), domuzīmi (-) vai pluszīmi (+) nesakārtotiem sarakstiem. Pasūtītiem sarakstiem mēs pievienojam prefiksu ar atbilstošo numuru un punktu:* Uzrakstiet apmācību * Publicējiet to Solvetic. 1. Jauna apmācība. 3. Izvēlieties sadaļu un līmeni. 2. Labojiet formātus un publicējiet.Tas izskatītos šādi:
- Uzrakstiet pamācību.
- Ievietojiet to vietnē Solvetic.
Uzskaitītajos sarakstos skaitļa hierarhija netiek ievērota, tiks izmantota pozīcija tajos.
- Jauna apmācība.
- Izvēlieties sadaļu un līmeni.
- Labojiet formātus un publicējiet.
Saites
Saites ievietošana ir ārkārtīgi noderīga un svarīga, jo tā ļauj atsaukties uz saturu uz kādu ārēju dokumentāciju vai apmācību.
Piemērs:Nginx serveris ir nodrošināts ar fail2ban, izmantojot [tutorial-solvetic] (http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo-con-ssh-y-nginx/)Mēs ievietojam iekavās [] vēlamajam tekstam ir saite, un tad mēs ievietojam starp iekavām () galamērķa saite.
Ja vēlaties to darīt sakārtotāk nekā atsauces teksta vidū, varat to izdarīt arī šādi:Nginx serveris ir nodrošināts ar fail2ban, izmantojot [1] ……… [1]: http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo-con-ssh-y- nginx/Vēl viena iespēja būtu:Nginx serveris ir nodrošināts ar fail2ban, izmantojot [fail2ban-nginx-solvetic] ……… [ssh-nginx-solvetic]: http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo- con-ssh-y-nginx /Tagad pievienojiet attēlus.
Attēli
Mēs varam pievienot attēlus, kas ir gandrīz līdzīgi saitēm, pievienojot a! Pirms katra man jāuzsver, ka nevar redzēt tos no termināļa, labi ne tieši.! [alternatīvs teksts] (attēla URL)Mēs varam izmantot tās pašas saišu iespējas, ja vēlamies, lai tās būtu sakārtotākas.
Dēļi
Es parasti ievietoju piekļuves datus serveru vai pakalpojumu tabulās.
Lai to izdarītu, mēs zīmējam tabulas līnijas ar caurulēm (|), lai norobežotu kolonnas un defises (-), lai atdalītu galveni no pārējām rindām:| Pakalpojums | Lietotājs | Atslēga | | ------------- | --------- | ----------- | | FTP | solvīts | aw-D.wak | | SSH | admin | 2 -.- am, |Mums būtu kaut kas līdzīgs šim:
Caurules nav jāsaskaņo, un "malas" nav obligātas, piemēram:
1. pozīcija | 2. pozīcija --- | --- mēģināsim | kaut ko izmēģināsim | kaut kas cits. Tas radītu to pašu tabulu.Varat arī izlīdzināt tekstu kolonnās, ievietojot kolu (uz defisi izgatavotā atdalītāja tajā pusē, kurā vēlaties ierindoties:
| Līdzinājums pa kreisi. | Centrēts | Izlīdzināts pa labi. | |: ------------------- |: --------: | ----------------- -: | | tests | tests | tests |Ne visi redaktori pieņem tabulas Markdown.
Kods
Mēs varam izcelt savu kodu ar atzīmi, un tas dažādās valodās atšķiras.Trīskāršā atpakaļejas sintakse
Šāda veida bloku ievietošana ir ļoti vienkārša, mums vienkārši jāpievieno koda bloks, kuru mēs vēlamies ievadīt.e 3 aizmugures atzīmes ("") kam seko tās valodas nosaukums, kurai pieder kods, kuru vēlaties ievietot:"valoda x = y …"JavaScript koda piemērs izskatās šādi:"" js funkciju tests () {console.log ("testēšana!")} "Tas ģenerētu jauku koda bloku ar JavaScript iezīmētu sintaksi:funkciju tests () {console.log ('testēšana!')}Sintakse pirms atstarpēm
Vēl viens veids, kā ievietot iepriekš formatētu tekstu vai kodu, bet bez noteiktas valodas, ir "ievilkt" mūsu tekstu ar 4 atstarpēm, mēs to rakstītu šādi:x = y // ievērojiet, ka starp malu un rakstīto ir 4 atstarpes.mums būs šāds rezultāts:x = y // ievērojiet, ka starp malu un rakstīto ir 4 atstarpes.Standarts pieņem opciju tikai ar iepriekšēju atstarpi.
SecinājumiLabai dokumentācijas sistēmai jābūt ātrai, elastīgai un vienkāršai. Jāatzīmē, ka atzīme ļoti labi aptver, mēs nedrīkstam aizmirst tās tīro acu sintaksi, kas jāņem vērā, ja vēlamies pārskatīt dokumentāciju no termināļa, izmantojot VIM / EMACS. Ierakstam ir pieeja sistēmu administratoriem, taču tas var būt ļoti noderīgs visu veidu profesionāļiem vai studentiem. Es ceru, ka visas šaubas vai ieteikumi ir skaidri izteikti, atstājiet tos komentāros.Vai jums patika šī apmācība un palīdzējāt tai?Jūs varat apbalvot autoru, nospiežot šo pogu, lai sniegtu viņam pozitīvu punktu
