Obsah
Co je to MarkdownJe definován stejně jako software napsaný v Zal, který převádí text zapsaný do HTML a navíc na syntaxi použitou k dosažení očekávaného výsledku HTML. Syntaxe navržená tak, aby byla jednoduchá pro každého, kdo chce psát na web, aniž by o tom musel vědět.
Dnes většina správců obsahu a dokonce i mnoho poštovních klientů podporuje použití syntaxe Markdown, nativně to má za cíl usnadnit vytváření formátovaného textu bez nutnosti implementovat styly nebo znát HTML. Tyto obslužné rutiny používají k převodu textu Markdown na HTML analyzátor.
MarkDown a dokumentace
Je velmi užitečné naučit se mnoho nástrojů dokumentace z markdownu; wikia, onenote, evernote, alfresco jej podporují nativně nebo pomocí třetích stran. Je důležité mít dokumentaci procesů a možných problémů, ale ještě důležitější je udržovat to čisté a čisté i z konzoly a markdown je zde, aby nám s tím pomohl.
Odstavce
Pokud bychom psali normálně ve společném editoru, definovali bychom odstavec jednoduše stisknutím několika:
Vstupte
A uvidíme, jak náš kurzor přejde o několik řádků níže a zapíše do nového odstavce.V HTML je známý jako odstavce.
V Markdownu je to stejně snadné jako v normálním editoru.
Navíc máme tu výhodu, že jeden konec řádku nerozdělí text na více řádků, pokud napíšeme něco takového:
Text. Další text.Bude to vypadat takto:
Text. Další text.Rovněž použití více oddělovacích čar zmenší na jeden oddělovací prostor mezi odstavci
Záhlaví
V normálním editoru bychom potřebovali panel nástrojů k definování stylu nadpisu pro text, nebo pokud se cítíte trochu nepořádně, stačilo by přejít na velikost písma a zvýraznit ji.
V HTML jsou známé jako
,
atd. z hlavičky.
V Markdownu je to velmi jednoduché, jednoduše musíte umístit číselný znak (#) jako předponu záhlaví, čím více z nich má nižší stupeň, v záhlaví bude maximálně 6.
Například záhlaví (největší) a jeden budou zapsány takto:
# Velká hlavička ### Malá hlavička
a výsledek bude takový.
V Markdownu je to velmi jednoduché, jednoduše musíte umístit číselný znak (#) jako předponu záhlaví, čím více z nich má nižší stupeň, v záhlaví bude maximálně 6.
Například záhlaví (největší) a jeden budou zapsány takto:
# Velká hlavička ### Malá hlavičkaa výsledek bude takový.
Skvělá hlavička
Malá hlavička
Oddělovače nelze běžně kreslit v jednoduchých editorech.
ZVĚTŠIT
V HTML se stávají horizontálních pravidel.Jsou ohraničeny zadáním 3 nebo více hvězdiček nebo pomlček. Může za nimi následovat nebo je oddělit mezera, je to lhostejné.
* * * *** - - - ---Důraz
Toto formátování je známé jako kurzíva a tučné písmo.
V HTML by to bylo Y .
Chcete -li vytvořit text s kurzívou, stačí text ohraničit mezi jednotlivými hvězdičkami nebo podtržítky a pro tučně mezi čtyřhry:
* text kurzívou. * _ text kurzívou ._ ** tučný text. ** __bold text .__Vypadalo by to nějak takto:
kurzívou. tučné písmo.
Přeškrtnuto
To vám umožní umístit text, jako kdybychom jej přeškrtávali, hodně využíván pro správu verzí. o Chyby opravené v aplikaci nebo systému.
V HTML by to bylo od přeškrtnutí.
Stačí text obklopit dvojitými velkými písmeny nebo tildami:
~~ přeškrtnutý text. ~~Tato možnost není standardem a nemusí fungovat ve všech editorech.
Citáty
Citační styl obvykle nelze v běžném textovém editoru snadno najít
V HTML by to bylo
.
Musíme pouze umístit znak „větší než“ (>) jako předponu následujícího textu (podobně jako adresování v linuxu)> Toto je citát.Vypadalo by to:Toto je citát.
Seznamy
K definování seznamu cílů obvykle používáme funkčnost odrážek pro seznamy bez konkrétního pořadí a číslované seznamy.
V HTML by to bylo pro neuspořádané seznamy, pro objednané seznamy a definovat každou položku v seznamu.
V Markdown je definujeme jednoduše tak, že každou položku předřadíme hvězdičkou (*), pomlčkou (-) nebo symbolem plus (+) pro neuspořádané seznamy. U seřazených seznamů předponujeme odpovídajícím číslem a bodem:* Napsat tutoriál * Publikovat v Solveticu. 1. Nový výukový program. 3. Vyberte sekci a úroveň. 2. Opravte formáty a publikujte.Vypadalo by to takto:
- Napište návod.
- Zveřejněte to na Solvetic.
V enumerovaných seznamech není respektována hierarchie čísla, bude použita pozice v nich.
- Nový výukový program.
- Vyberte sekci a úroveň.
- Opravte formáty a publikujte.
Odkazy
Umístění odkazů je velmi užitečné a důležité, protože vám umožňuje odkazovat na obsah v externí dokumentaci nebo v tutoriálu.
Příklad:Server Nginx byl zabezpečen pomocí fail2ban pomocí [tutorial-solvetic] (http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo-con-ssh-y-nginx/)Dali jsme do závorek [] požadovaný text má odkaz a poté jej umístíme mezi závorky () odkaz na cíl.
Pokud dáváte přednost tomu, aby to bylo uspořádanější než odkazy uprostřed textu, můžete to udělat také následujícím způsobem:Server Nginx byl zabezpečen pomocí fail2ban pomocí [1] ……… [1]: http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo-con-ssh-y- nginx/Další možností by bylo:Server Nginx byl zabezpečen pomocí fail2ban pomocí [fail2ban-nginx-solvetic] ……… [ssh-nginx-solvetic]: http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo- con-ssh-y-nginx /Nyní přidejte obrázky.
snímky
Můžeme přidat obrázky téměř podobné odkazům přidáním! Před každým musím zdůraznit, že je nevidím z terminálu, tedy ne přímo.! [alternativní text] (adresa URL obrázku)Můžeme použít stejné možnosti odkazů, pokud chceme, aby to bylo organizovanější.
Desky
Přístupové údaje obvykle vkládám do tabulek serverů nebo služeb.
Chcete-li to provést, nakreslíme čáry tabulky pomocí potrubí (|) k oddělení sloupců a pomlček (-) k oddělení záhlaví od ostatních řádků:| Služba | Uživatel | Klíč | | ------------- | --------- | ----------- | | FTP | solvetic | aw-D.wak | | SSH | admin | 2 -.- dopoledne, |Měli bychom něco takového:
Trubky nemusí být zarovnány a „hrany“ jsou volitelné, například:Okruh 1 | Okruh 2 --- | --- zkusme | něco zkusíme nějaké | něco jiného.To by generovalo stejnou tabulku.Text ve sloupcích můžete také zarovnat umístěním symbolu dvojtečky ( na oddělovači spojovníku na straně, kterou chcete seřadit:| Zarovnáno doleva. | Na střed | Zarovnáno doprava. | |: ------------------- |: --------: | ----------------- -: | | test | test | test |Ne všichni redaktoři akceptují tabulky v Markdownu.
Kód
Náš kód můžeme zvýraznit pomocí markdownu a ten se v jednotlivých jazycích liší.Trojitá syntaxe backticku
Umístění tohoto typu bloků je velmi snadné, musíme pouze uzavřít blok kódu, který chceme zadat.e 3 backticks (`` '') následuje název jazyka, do kterého kód, který chcete umístit, patří:`` jazyk x = y … ``Příklad kódu JavaScript by vypadal nějak takto:`` `` js test funkce () {console.log ('testování!')} ''To by generovalo pěkný blok kódu se zvýrazněnou syntaxí pro javascript:test funkce () {console.log ('testování!')}Syntaxe před mezerami
Dalším způsobem, jak umístit předem formátovaný text nebo kód, ale bez zadaného jazyka, je „odsazení“ našeho textu na 4 mezery, napsali bychom to takto:x = y // všimněte si, že mezi okrajem a tím, co píšeme, jsou 4 mezery.budeme mít tento výsledek:x = y // všimněte si, že mezi okrajem a tím, co píšeme, jsou 4 mezery.Standard přijímá pouze možnost s přednastavením.
ZávěryDobrý systém dokumentace musí být rychlý, flexibilní a jednoduchý. Body, které markdown pokrývá velmi dobrým způsobem, nesmíme zapomenout na jeho čistou syntaxi pro oči, což je něco, co je třeba vzít v úvahu, pokud chceme dokumentaci prohlížet z terminálu pomocí VIM / EMACS. Záznam má přístup pro správce systému, ale může být velmi užitečný pro všechny typy profesionálů nebo studentů. Doufám, že jakékoli pochybnosti nebo návrhy byly objasněny, nechte je v komentářích.Líbil se vám tento návod a pomohl mu?Autora můžete odměnit stisknutím tohoto tlačítka, čímž mu dáte kladný bod