Sadržaj
Što je MarkdownDefiniran je koliko i softver napisan Pol, koji pretvara tekst napisan u HTML i dodatno u sintaksu koja se koristi za postizanje očekivanog HTML rezultata. Sintaksa dizajnirana da bude jednostavna za svakoga tko želi pisati na webu, bez potrebe za tim.
Danas većina upravitelja sadržaja, pa čak i mnogi klijenti pošte podržavaju upotrebu Markdown sintakse, izvorno, to s namjerom da olakša stvaranje oblikovanog teksta bez potrebe za implementacijom stilova ili poznavanjem HTML -a. Ovi rukovatelji koriste parser za pretvaranje Markdown teksta u HTML.
MarkDown i dokumentacija
Vrlo je korisno naučiti mnoge alate za dokumentaciju od markdown -a; wikia, onenote, evernote, alfresco podržavaju izvorno ili uz pomoć trećih strana. Važno je imati dokumentaciju o procesima i mogućim problemima, ali još je važnije održavati je urednom i čistom čak i s konzole, a markdown je tu da nam pomogne u tome.
Odlomci
Da smo normalno pisali u zajedničkom uređivaču, za definiranje odlomka jednostavno bismo pritisnuli nekoliko:
Unesi
Vidjet ćemo kako naš kursor ide nekoliko redaka ispod za upis u novi odlomak.U HTML -u je poznat kao stavka.
U Markdownu je jednostavno kao i u normalnom uređivaču.
Osim toga, imamo prednost što jedan prijelom retka ne razdvaja tekst na više redaka, ako napišemo nešto poput ovoga:
Tekst. Još jedan tekst.To će izgledati ovako:
Tekst. Još jedan tekst.Korištenje više linija za razdvajanje također se smanjuje na jedan razdjelnik između odlomaka
Zaglavlja
U normalnom uređivaču potrebna nam je alatna traka za definiranje stila zaglavlja za tekst, ili ako se osjećate pomalo neuredno, bilo bi dovoljno da podignete veličinu fonta i podebljate ga.
U HTML -u su poznati kao
,
itd. iz zaglavlja.
U Markdownu je vrlo jednostavno, jednostavno morate postaviti brojčani broj (#) kao prefiks zaglavlja, što više njih ima niži stupanj zaglavlja će biti maksimalno do 6.
Na primjer zaglavlje (najveći) i jedan napisali bi se ovako:
# Veliko zaglavlje ### Malo zaglavlje
a rezultat će biti ovakav.
U Markdownu je vrlo jednostavno, jednostavno morate postaviti brojčani broj (#) kao prefiks zaglavlja, što više njih ima niži stupanj zaglavlja će biti maksimalno do 6.
Na primjer zaglavlje (najveći) i jedan napisali bi se ovako:
# Veliko zaglavlje ### Malo zaglavljea rezultat će biti ovakav.
Odlično zaglavlje
Mali zaglavlje
Odvajače obično nije moguće nacrtati u jednostavnim uređivačima.
POVEĆAJTE
U HTML -u postaju horizontalnih pravila.Razgraničavaju se upisivanjem 3 ili više zvjezdica ili crtica. Mogu ih pratiti ili odvojiti razmakom, ravnodušan je.
* * * *** - - - ---Naglasak
Ovo oblikovanje poznato je kao kurzivo i podebljano.
U HTML -u bi to bilo Y .
Da biste stvorili tekst s kurzivnim formatom, morate samo okružiti tekst između pojedinačnih zvjezdica ili donjih crta, a za podebljano između dvostrukih:
* kurzivni tekst. * _ kurzivni tekst._ ** podebljani tekst. ** __ podebljani tekst .__To bi izgledalo otprilike ovako:
kurzivni tekst. podebljan tekst.
Precrtano
To vam omogućuje da tekst postavite kao da ga precrtavamo, a koristi se puno za kontrolu verzija. o Greške koje su ispravljene u aplikaciji ili sustavu.
U HTML -u bi to bilo od precrtavanja.
Tekst je dovoljno okružiti velikim slovima ili tildama:
~~ precrtani tekst. ~~Ova opcija nije standardna i možda neće raditi u svim urednicima.
Citati
Stil citiranja obično se ne može lako pronaći u uobičajenom uređivaču teksta
U HTML -u bi to bilo
.
Moramo samo postaviti znak "veće od" (>) kao prefiks tekstu koji slijedi (slično adresiranju u linuxu)> Ovo je citat.Izgledalo bi:Ovo je citat.
Popisi
Za definiranje popisa ciljeva obično koristimo funkcije grafičkih oznaka za popise bez određenog redoslijeda i numeriranih popisa.
U HTML -u bi to bilo za neuređene liste, za naručene popise i za definiranje svake stavke na popisu.
U Markdownu ih definiramo jednostavno stavljanjem svake stavke ispred zvjezdice (*), crtice (-) ili simbola plus (+) za neuređene popise. Za uređene popise stavljamo prefiks s odgovarajućim brojem i točkom:* Napišite vodič * Objavite ga u Solveticu. 1. Novi udžbenik. 3. Odaberite odjeljak i razinu. 2. Ispravite formate i objavite.To bi izgledalo ovako:
- Napišite vodič.
- Objavi na Solveticu.
U navedenim popisima ne poštuje se hijerarhija broja, koristit će se položaj unutar njih.
- Novi vodič.
- Odaberite odjeljak i razinu.
- Ispravite formate i objavite.
Veze
Postavljanje veza iznimno je korisno i važno jer vam omogućuje upućivanje sadržaja na neku vanjsku dokumentaciju ili vodič.
Primjer:Nginx poslužitelj osiguran je fail2ban pomoću [tutorial-Solticic] (http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo-con-ssh-y-nginx/)Stavili smo zagrade [] tekst koji želimo ima vezu, a zatim stavljamo između zagrada () odredišnu vezu.
Ako to želite učiniti urednije nego da reference budu u sredini vašeg teksta, to možete učiniti i na sljedeći način:Nginx poslužitelj osiguran je fail2ban pomoću [1] ……… [1]: http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo-con-ssh-y- nginx/Druga mogućnost bila bi:Nginx poslužitelj je osiguran sa fail2ban pomoću [fail2ban-nginx-solutiontic] ……… [ssh-nginx-solutiontic]: http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo- con-ssh-y-nginx /Sada dodajte slike.
Slike
Slike koje su gotovo slične vezama možemo dodati dodavanjem a! Prije svakog, moram naglasiti da ih ne mogu vidjeti s terminala, pa ne izravno.! [zamjenski tekst] (image-url)Možemo koristiti iste opcije veza ako ih želimo organizirati.
Ploče
Pristupne podatke obično stavljam u tablice poslužitelja ili usluga.
Da bismo to učinili, nacrtamo linije tablice s cijevima (|) kako bismo ograničili stupce i crtice (-) kako bismo odvojili zaglavlje od ostatka redaka:| Usluga | Korisnik | Ključ | | ------------- | --------- | ----------- | | FTP | rješavanje | aw-D.wak | | SSH | admin | 2 -.- ujutro, |Imali bismo ovako nešto:
Cijevi ne moraju biti poravnane, a "rubovi" su izborni, na primjer:Naslov 1 | Naslov 2 --- | --- pokušajmo | probajmo nešto | nešto drugo.Ovo bi generiralo istu tablicu.Također možete poravnati tekst u stupcima postavljanjem simbola dvotočke ( na separatoru sa crticama na strani na kojoj želite biti poredani:| Poravnano ulijevo. | Centrirano | Poravnano desno. | |: ------------------- |: --------: | ----------------- -: | | test | test | test |Ne prihvaćaju svi urednici tablice u Markdownu.
Kodirati
Naš kôd možemo istaknuti markdown -om i razlikuje se od jezika do jezika.Sintaksa s trostrukim zadnjicom
Postavljanje ove vrste blokova vrlo je jednostavno, samo moramo priložiti blok koda koji želimo unijeti.e 3 zadnjice (`` `) iza kojeg slijedi naziv jezika kojem pripada kôd koji želite postaviti:`` `language x = y …` `Primjer JavaScript koda izgledao bi otprilike ovako:`` `` js funkcija test () {console.log ('testing!')} ''Ovo bi generiralo lijep blok koda sa naglašenom sintaksom za javascript:function test () {console.log ('testing!')}Sintaksa prije razmaka
Drugi način postavljanja unaprijed formatiranog teksta ili koda, ali bez navedenog jezika je "uvlačenjem" našeg teksta s 4 razmaka, napisali bismo ga ovako:x = y // uočite da postoje 4 razmaka između margine i onoga što pišemo.imat ćemo ovaj rezultat:x = y // uočite da postoje 4 razmaka između margine i onoga što pišemo.Standard prihvaća samo opciju s predrazmakom.
ZaključciDobar dokumentacijski sustav mora biti brz, fleksibilan i jednostavan. Točke koje umanjivanje pokriva na vrlo dobar način, ne smijemo zaboraviti njegovu čistu sintaksu za oči, nešto što treba uzeti u obzir ako želimo pregledati dokumentaciju s terminala pomoću VIM / EMACS -a. Unos ima pristup administratorima sustava, ali može biti vrlo koristan za sve vrste profesionalaca ili studenata. Nadam se da su sve nedoumice ili prijedlozi razjašnjeni, ostavite ih u komentarima.Je li vam se svidio i pomogao ovaj vodič?Autor možete nagraditi pritiskom na ovaj gumb kako biste mu dali pozitivan bod