Hur man skriver med Markdown och dess skillnader med HTML.

Vad är Markdown
Det definieras lika mycket som programvara som skrivs in Perl, som konverterar texten skriven till HTML och dessutom till syntaxen som används för att nå det HTML -resultat vi förväntar oss. En syntax utformad för att vara enkel för alla som vill skriva på webben, utan att behöva ha kunskap om det.
Idag stöder de flesta innehållshanterare och till och med många e -postklienter användningen av Markdown -syntax, inbyggt, detta med avsikt att underlätta skapandet av formaterad text utan att behöva implementera stilar eller kunna HTML. Dessa hanterare använder en parser för att konvertera Markdown -text till HTML.
MarkDown och dokumentation
Det är mycket användbart att lära sig många dokumentationsverktyg från markdown; wikia, onenote, evernote, alfresco stödjer det inbyggt eller med hjälp av tredje part. Det är viktigt att ha dokumentation av processerna och eventuella problem, men ännu viktigare är att hålla det snyggt och rent även från konsolen och markdown är här för att hjälpa oss med det.
Stycken
Om vi ​​skrev normalt i en vanlig redaktör, för att definiera ett stycke skulle vi helt enkelt trycka på ett par:

Stiga på

Och vi kommer att se vår markör gå ett par rader nedan för att skriva i ett nytt stycke.
I HTML är det känt som

av stycket.
I Markdown är det lika enkelt som i en vanlig redaktör.
Dessutom har vi fördelen att ett enda radbrytning inte separerar texten i flera rader, om vi skriver något så här:

 En text. En annan text.
Det kommer att se ut så här:
 En text. En annan text.
Att använda flera separatorlinjer reducerar på samma sätt till ett enda separatorutrymme mellan styckena
Rubriker
I en vanlig redaktör skulle vi behöva verktygsfältet för att definiera en rubrikstil för en text, eller om du känner dig lite rörig skulle det vara tillräckligt att gå upp till teckensnittsstorleken och göra den fet.
I HTML är de kända som

,

, etc, från rubrik.
I Markdown är det väldigt enkelt, du måste helt enkelt placera siffertecknet (#) som ett prefix till rubriken, ju fler av dessa har den lägre graden som rubriken kommer att vara upp till maximalt 6.
Till exempel en rubrik (den största) och en de skulle skrivas så här:
 # Stor rubrik ### Liten rubrik
och resultatet blir så här.

Bra rubrik
Liten rubrik

Separatorer
Separatorer är normalt inte möjligt att dra in enkla redaktörer.

FÖRSTORA

I HTML blir de av horisontella regler.
De avgränsas genom att skriva 3 eller fler asterisker eller bindestreck. De kan följas eller separeras av ett mellanslag, det är likgiltigt.
 * * * *** - - - ---
Betoning
Denna formatering är känd som kursiv och fetstil.
I HTML skulle det vara Y .
För att skapa text med kursiv format behöver du bara omge texten mellan enstaka asterisker eller understreck, och för fetstil mellan dubbel:
 * kursiv text. * _ kursiv text. _ ** fet text. ** __ fet text .__
Det skulle se ut ungefär så här:
kursiv text. fettext.
Genomslag
Detta låter dig placera text som om vi skulle stryka över den, används mycket för versionskontroll. o Fel som korrigerades i en applikation eller ett system.
I HTML skulle det vara från genomstrykning.
Det räcker med att omge texten mellan dubbla versaler eller tildes:
 ~~ genomtänkt text. ~~
Det här alternativet är inte en standard och kanske inte fungerar i alla redaktörer.
Citat
Citatstilen är vanligtvis inte lätt att hitta i en vanlig textredigerare
I HTML skulle det vara
.
Vi måste bara placera "större än" -tecknet (>) som ett prefix till texten som följer (liknande adresseringen i Linux)
 > Detta är ett citat.
Det skulle se ut:

Detta är ett citat.


Listor
För att definiera en mållista använder vi vanligtvis funktionaliteten hos kulor för listor utan specifik ordning och numrerade listor.
I HTML skulle det vara för oordnade listor, för beställda listor och för att definiera varje objekt i listan.
I Markdown definierar vi dem helt enkelt genom att prefixa varje objekt med en asterisk (*), streck (-) eller plussymbol (+) för orordnade listor. För ordnade listor prefixar vi med motsvarande nummer och en punkt:
 * Skriv handledning * Publicera den på Solvetic. 1. Ny handledning. 3. Välj en sektion och nivå. 2. Rätt format och publicera.
Det skulle se ut så här:
  • Skriv handledning.
  • Lägg upp det på Solvetic.
  • Ny handledning.
  • Välj en sektion och nivå.
  • Rätt format och publicera.
I uppräknade listor respekteras inte hierarkin för numret, positionen inom dem kommer att användas.
Länkar
Att placera länkar är oerhört användbart och viktigt eftersom det låter dig referera innehåll till viss extern dokumentation eller en självstudie.
Exempel:
 Nginx-servern har säkrats med fail2ban med [tutorial-solvetic] (http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo-con-ssh-y-nginx/)
Vi sätter inom parentes [] texten som vi vill ha har länken och sedan placerar vi mellan parenteser () destinationslänken.
Om du föredrar att göra det på ett mer ordnat sätt än att ha referenserna i mitten av din text, kan du också göra det på följande sätt:
 Nginx-servern har säkrats med fail2ban med [1] ……… [1]: http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo-con-ssh-y- nginx/
Ett annat alternativ skulle vara:
 Nginx-servern har säkrats med fail2ban med [fail2ban-nginx-solvetic] ……… [ssh-nginx-solvetic]: http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo- con-ssh-y-nginx /
Lägg nu till bilder.
Bilder
Vi kan lägga till bilder som nästan liknar länkar genom att lägga till en! Innan var och en måste jag betona att jag inte kan se dem från en terminal, ja inte direkt.
 ! [alternativ text] (bild-url)
Vi kan använda samma alternativ för länkarna om vi vill ha det mer organiserat.
Styrelser
Jag brukar lägga åtkomstdata i tabeller över servrar eller tjänster.
För att göra detta ritar vi tabellens linjer med rör (|) för att avgränsa kolumnerna och bindestreckarna (-) för att skilja rubriken från resten av raderna:
 | Service | Användare | Nyckel | | ------------- | --------- | ----------- | | FTP | solvetic | aw-D.wak | | SSH | admin | 2 -.- am, |
Vi skulle ha något så här:

Rören behöver inte justeras, och "kanterna" är valfria, till exempel:
 Rubrik 1 | Rubrik 2 --- | --- låt oss försöka | något låt oss prova några. Detta skulle generera samma tabell. 
Du kan också justera texten i dina kolumner genom att placera kolon -symbolen (:) på bindestreckens separator på den sida du vill ställa upp:
 | Vänsterinriktad. | Centrerad | Inriktad till höger. | |: ------------------- |: --------: | ----------------- -: | | test | test | test |
Alla redaktörer accepterar inte tabeller i Markdown.
Koda
Vi kan markera vår kod med markdown och den skiljer sig från ett språk till ett annat.

Trippel backtick -syntax


Att placera denna typ av block är väldigt enkelt, vi måste bara bifoga blocket av kod som vi vill ange.e 3 backticks (`` '') följt av namnet på språket som koden du vill placera tillhör:
 `` språk x = y … ''
Ett exempel på JavaScript -kod skulle se ut så här:
 `` '' js function test () {console.log ('testing!')} ''
Detta skulle generera ett trevligt kodblock med syntax markerad för javascript:
 funktionstest () {console.log ('testning!')}

Syntax före avstånd


Ett annat sätt att placera förformaterad text eller kod men utan specificerat språk är genom att "indraga" vår text med 4 mellanslag, skulle vi skriva det så här:
 x = y // märker att det finns 4 mellanslag mellan marginalen och det vi skriver.
vi kommer att ha detta resultat:
 x = y // märker att det finns 4 mellanslag mellan marginalen och det vi skriver.
Standarden accepterar endast alternativet med försteg.
SlutsatserEtt bra dokumentationssystem måste vara snabbt, flexibelt och enkelt. Punkter som markdown täcker på ett mycket bra sätt, vi får inte glömma dess rena syntax för ögonen, något att ta hänsyn till om vi vill granska dokumentationen från en terminal med VIM / EMACS. Posten har ett tillvägagångssätt för systemadministratörer men det kan vara mycket användbart för alla typer av proffs eller studenter. Jag hoppas att alla tvivel eller förslag har blivit tydliga, lämna det i kommentarerna.Gillade du och hjälpte denna handledning?Du kan belöna författaren genom att trycka på den här knappen för att ge honom en positiv poäng

wave wave wave wave wave