Indholdsfortegnelse
Hvad er MarkdownDet er defineret så meget som software skrevet i Oml, som konverterer teksten skrevet til HTML og derudover til den syntaks, der bruges til at nå det HTML -resultat, vi forventer. En syntaks, der er designet til at være enkel for alle, der ønsker at skrive på nettet uden behov for kendskab til det.
I dag understøtter de fleste indholdsadministratorer og endda mange mailklienter brugen af Markdown -syntaks, indfødt dette med det formål at lette oprettelsen af formateret tekst uden at skulle implementere stilarter eller kende HTML. Disse behandlere bruger en parser til at konvertere Markdown -tekst til HTML.
MarkDown og dokumentation
Det er meget nyttigt at lære mange dokumentationsværktøjer fra markdown; wikia, onenote, evernote, alfresco understøtter det indbygget eller ved hjælp af tredjeparter. Det er vigtigt at have dokumentation for processerne og mulige problemer, men endnu vigtigere er at holde det pænt og rent, selv fra konsollen, og markdown er her for at hjælpe os med det.
Afsnit
Hvis vi skrev normalt i en fælles editor, for at definere et afsnit, ville vi blot trykke på et par af:
Gå ind
Og vi vil se vores markør gå et par linjer herunder for at skrive i et nyt afsnit.I HTML er det kendt som af afsnittet.
I Markdown er det lige så let som i en normal editor.
Derudover har vi den fordel, at et enkelt linjeskift ikke adskiller teksten til flere linjer, hvis vi skriver sådan noget:
En tekst. Endnu en tekst.Det vil se sådan ud:
En tekst. Endnu en tekst.Brug af flere skillelinjer reducerer ligeledes til et enkelt separatorrum mellem afsnit
Overskrifter
I en normal editor ville vi have brug for værktøjslinjen til at definere en overskriftsstil for en tekst, eller hvis du føler dig lidt rodet, ville det være nok at gå op til skriftstørrelsen og gøre den fed.
I HTML er de kendt som
,
osv. fra header.
I Markdown er det meget enkelt, du skal simpelthen placere taltegnet (#) som et præfiks til overskriften, jo flere af disse har den lavere grad, headeren vil være op til maksimalt 6.
For eksempel en overskrift (den største) og en de ville blive skrevet sådan:
# Stort overskrift ### Lille overskrift
og resultatet bliver sådan.
I Markdown er det meget enkelt, du skal simpelthen placere taltegnet (#) som et præfiks til overskriften, jo flere af disse har den lavere grad, headeren vil være op til maksimalt 6.
For eksempel en overskrift (den største) og en de ville blive skrevet sådan:
# Stort overskrift ### Lille overskriftog resultatet bliver sådan.
Fantastisk header
Lille overskrift
Separatorer er normalt ikke mulige at tegne i simple redaktører.
FORSTØRRE
De afgrænses ved at skrive 3 eller flere stjerner eller bindestreger. De kan følges eller adskilles af et mellemrum, det er ligegyldigt.
* * * *** - - - ---Vægt
Denne formatering er kendt som kursiv og fed.
I HTML ville det være Y .
For at oprette tekst med kursiv format skal du blot omslutte teksten mellem enkelte stjerner eller understregninger, og med fed skrift mellem dobbelte:
* kursiv tekst. * _ kursiv tekst. _ ** fed tekst. ** __ fed tekst .__Det ville se sådan ud:
kursiv tekst. fed tekst.
Gennemsigtig
Dette giver dig mulighed for at placere tekst, som om vi krydsede den, brugt meget til versionskontrol. o Fejl, der blev rettet i en applikation eller et system.
I HTML ville det være gennemstrikning.
Det er nok at omslutte teksten mellem dobbelt hovedstæder eller tildes:
~~ gennemstreget tekst. ~~Denne indstilling er ikke en standard og fungerer muligvis ikke i alle redaktører.
Citater
Citeringsstilen findes normalt ikke let i en almindelig tekstredigerer
I HTML ville det være
.
Vi skal bare placere "større end" -tegnet (>) som et præfiks til den efterfølgende tekst (ligner adresseringen i linux)> Dette er et citat.Det ville se ud:Dette er et citat.
Lister
For at definere en liste over mål bruger vi normalt funktionaliteten af kugler til lister uden specifik rækkefølge og nummererede lister.
I HTML ville det være for uordnede lister, for bestilte lister og for at definere hvert element på listen.
I Markdown definerer vi dem blot ved at præfiksere hvert element med en stjerne (*), bindestreg (-) eller plus-symbol (+) for uordnede lister. For bestilte lister præfikerer vi det tilsvarende nummer og et punkt:* Skriv selvstudium * Udgiv det på Solvetic. 1. Ny vejledning. 3. Vælg en sektion og et niveau. 2. Korrekte formater og offentliggør.Det ville se sådan ud:
- Skriv selvstudium.
- Send det på Solvetic.
I opregnede lister respekteres hierarkiet for tallet ikke, positionen inden for dem vil blive brugt.
- Ny vejledning.
- Vælg en sektion og et niveau.
- Korrekte formater og offentliggør.
Links
Placering af links er ekstremt nyttigt og vigtigt, da det giver dig mulighed for at henvise indhold til ekstern dokumentation eller en tutorial.
Eksempel:Nginx-serveren er blevet sikret med fail2ban ved hjælp af [tutorial-solvetic] (http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo-con-ssh-y-nginx/)Vi sætter i parentes [] den tekst, vi ønsker, har linket, og så placerer vi mellem parenteser () destinationslinket.
Hvis du foretrækker at gøre det på en mere velordnet måde end at have referencerne i midten af din tekst, kan du også gøre det på følgende måde:Nginx-server er blevet sikret med fail2ban ved hjælp af [1] ……… [1]: http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo-con-ssh-y- nginx/En anden mulighed ville være:Nginx-serveren er blevet sikret med fail2ban ved hjælp af [fail2ban-nginx-solvetic] ……… [ssh-nginx-solvetic]: http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo- con-ssh-y-nginx /Tilføj nu billeder.
Billeder
Vi kan tilføje billeder, der næsten ligner links ved at tilføje en! Før hver enkelt skal jeg understrege ikke at kunne se dem fra en terminal, vel ikke direkte.! [alternativ tekst] (image-url)Vi kan bruge de samme muligheder i linkene, hvis vi vil have det mere organiseret.
Tavler
Jeg lægger normalt adgangsdata i tabeller over servere eller tjenester.
For at gøre dette tegner vi tabellerne med rør (|) for at afgrænse kolonner og bindestreger (-) for at adskille overskriften fra resten af rækker:| Service | Bruger | Nøgle | | ------------- | --------- | ----------- | | FTP | solvetic | aw-D.wak | | SSH | admin | 2 -.- am, |Vi ville have sådan noget:
Rørene skal ikke justeres, og "kanterne" er valgfri, f.eks .:
Overskrift 1 | Overskrift 2 --- | --- lad os prøve | noget lad os prøve noget | Dette ville generere den samme tabel.Du kan også justere teksten i dine kolonner ved at placere kolon symbolet (på bindestreg lavet separator på den side, du vil have stillet op:
| Venstrejusteret. | Centreret | Justeret til højre. | |: ------------------- |: --------: | ----------------- -: | | test | test | test |Ikke alle redaktører accepterer tabeller i Markdown.
Kode
Vi kan fremhæve vores kode med markdown, og den adskiller sig fra et sprog til et andet.Triple backtick syntaks
Det er meget let at placere denne type blokke, vi skal bare vedlægge den kodeblok, som vi vil indtaste.e 3 backticks (`` '') efterfulgt af navnet på det sprog, som koden, du vil placere, tilhører:`` sprog x = y … ''Et eksempel på JavaScript -kode ville se sådan ud:`` `` js function test () {console.log ('testing!')} ''Dette ville generere en god kodeblok med syntaks fremhævet til javascript:funktionstest () {console.log ('test!')}Syntaks før afstand
En anden måde at placere præformateret tekst eller kode på, men uden et bestemt sprog er ved at "indrykke" vores tekst med 4 mellemrum, vi ville skrive det sådan:x = y // bemærk, at der er 4 mellemrum mellem margenen og det, vi skriver.vi får dette resultat:x = y // bemærk, at der er 4 mellemrum mellem margenen og det, vi skriver.Standarden accepterer kun indstillingen med forudindstilling.
KonklusionerEt godt dokumentationssystem skal være hurtigt, fleksibelt og enkelt. Punkter, som markdown dækker på en meget god måde, må vi ikke glemme dens rene syntaks for øjnene, noget at tage højde for, hvis vi vil gennemgå dokumentationen fra en terminal ved hjælp af VIM / EMACS. Posten har en tilgang til systemadministratorer, men den kan være meget nyttig for alle typer fagfolk eller studerende. Jeg håber, at enhver tvivl eller forslag er blevet klarlagt, lad det stå i kommentarerne.Kan du lide og hjælpe denne vejledning?Du kan belønne forfatteren ved at trykke på denne knap for at give ham et positivt punkt
