Spisie treści
Co to jest przecenaDefiniuje się ją tak samo, jak oprogramowanie napisane w Zal, która konwertuje tekst zapisany na HTML i dodatkowo na składnię używaną do uzyskania oczekiwanego wyniku HTML. Składnia zaprojektowana tak, aby była prosta dla każdego, kto chce pisać w sieci, bez potrzeby znajomości tego.
Obecnie większość menedżerów treści, a nawet wielu klientów pocztowych, obsługuje natywnie korzystanie ze składni Markdown, aby ułatwić tworzenie sformatowanego tekstu bez konieczności wdrażania stylów lub znajomości języka HTML. Te programy obsługi używają parsera do konwersji tekstu Markdown na HTML.
MarkDown i dokumentacja
Bardzo przydatne jest poznanie wielu narzędzi dokumentacji z przecen; wikia, onenote, evernote, alfresco obsługują go natywnie lub z pomocą osób trzecich. Ważne jest, aby mieć dokumentację procesów i ewentualnych problemów, ale jeszcze ważniejsze jest utrzymywanie jej w porządku i czystości nawet z konsoli, a przecena jest tutaj, aby nam w tym pomóc.
Paragrafy
Gdybyśmy pisali normalnie w zwykłym edytorze, aby zdefiniować akapit, po prostu wcisnęlibyśmy kilka:
Wchodzić
Zobaczymy, jak nasz kursor przejdzie kilka linijek poniżej, aby napisać nowy akapit.W HTML jest znany jako ust.
W Markdown jest to tak proste, jak w normalnym edytorze.
Dodatkowo mamy tę zaletę, że pojedynczy podział wiersza nie dzieli tekstu na wiele wierszy, jeśli napiszemy coś takiego:
Tekst. Kolejny tekst.Będzie to wyglądać tak:
Tekst. Kolejny tekst.Używanie wielu linii oddzielających również zmniejsza się do pojedynczego odstępu między akapitami
Nagłówki
W normalnym edytorze potrzebowalibyśmy paska narzędzi, aby zdefiniować styl nagłówka dla tekstu, lub jeśli czujesz się trochę bałaganiarski, wystarczyłoby zwiększyć rozmiar czcionki i pogrubić ją.
W HTML są one znane jako
,
itp. z nagłówka.
W Markdown jest to bardzo proste, wystarczy umieścić znak numeryczny (#) jako przedrostek nagłówka, im więcej z nich ma niższy stopień nagłówka, maksymalnie do 6.
Na przykład nagłówek (największy) i jeden byłyby napisane tak:
# Duży nagłówek ### Mały nagłówek
a wynik będzie taki.
W Markdown jest to bardzo proste, wystarczy umieścić znak numeryczny (#) jako przedrostek nagłówka, im więcej z nich ma niższy stopień nagłówka, maksymalnie do 6.
Na przykład nagłówek (największy) i jeden byłyby napisane tak:
# Duży nagłówek ### Mały nagłóweka wynik będzie taki.
Świetny nagłówek
Mały nagłówek
W prostych edytorach zwykle nie można narysować separatorów.
POWIĘKSZAĆ
W HTML stają się zasad horyzontalnych.Są one rozdzielane przez wpisanie 3 lub więcej gwiazdek lub myślników. Mogą następować po nich lub oddzielać je spacją, jest to obojętne.
* * * *** - - - ---Podkreślenie
To formatowanie jest znane jako kursywa i pogrubienie.
W HTML byłoby to Tak .
Aby utworzyć tekst w formacie kursywy, wystarczy otoczyć tekst między pojedynczymi gwiazdkami lub podkreśleniami, a pogrubienie między podwójnymi:
* tekst kursywą. * _ tekst kursywą._ ** tekst pogrubiony. ** __tekst pogrubiony .__Wyglądałoby to mniej więcej tak:
tekst kursywą. pogrubiony tekst.
Przekreślenie
Pozwala to na umieszczanie tekstu tak, jakbyśmy go przekreślali, często używane do kontroli wersji. o Błędy, które zostały poprawione w aplikacji lub systemie.
W HTML byłoby to od przekreślenia.
Wystarczy otoczyć tekst między podwójnymi wielkimi literami lub tyldami:
~~ przekreślony tekst. ~~Ta opcja nie jest standardem i może nie działać we wszystkich edytorach.
cytaty
Styl cytowania zwykle nie jest łatwy do znalezienia w zwykłym edytorze tekstu
W HTML byłoby to
.
Wystarczy umieścić znak „większy niż” (>) jako przedrostek do następującego tekstu (podobnie jak adresowanie w linuksie)> To jest cytat.Wyglądałoby to:To jest cytat.
Listy
Do zdefiniowania listy celów zazwyczaj wykorzystujemy funkcjonalność punktorów dla list bez określonej kolejności i list numerowanych.
W HTML byłoby to dla list nieuporządkowanych, dla uporządkowanych list i aby zdefiniować każdą pozycję na liście.
W Markdown definiujemy je po prostu, poprzedzając każdy element gwiazdką (*), myślnikiem (-) lub symbolem plusa (+) dla nieuporządkowanych list. W przypadku list uporządkowanych prefiksem jest odpowiedni numer i punkt:* Napisz tutorial * Opublikuj go w Solvetic. 1. Nowy samouczek. 3. Wybierz sekcję i poziom. 2. Popraw formaty i opublikuj.Wyglądałoby to tak:
- Napisz samouczek.
- Opublikuj to na Solvetic.
W listach wyliczanych nie jest przestrzegana hierarchia numeru, zostanie wykorzystana pozycja w nich.
- Nowy samouczek.
- Wybierz sekcję i poziom.
- Popraw formaty i opublikuj.
Spinki do mankietów
Umieszczanie linków jest niezwykle przydatne i ważne, ponieważ pozwala na odniesienie treści do zewnętrznej dokumentacji lub samouczka.
Przykład:Serwer Nginx został zabezpieczony za pomocą fail2ban przy użyciu [tutorial-solvetic] (http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo-con-ssh-y-nginx/)Wstawiamy w nawiasy [] tekst, który chcemy, ma link, a następnie umieszczamy go w nawiasach () link docelowy.
Jeśli wolisz to zrobić w bardziej uporządkowany sposób niż umieszczać odnośniki w środku tekstu, możesz to zrobić również w następujący sposób:Serwer Nginx został zabezpieczony za pomocą fail2ban przy użyciu [1]……… [1]: http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo-con-ssh-ynginx /Inną opcją byłoby:Serwer Nginx został zabezpieczony za pomocą fail2ban przy użyciu [fail2ban-nginx-solvetic]……… [ssh-nginx-solvetic]: http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo - con-ssh-y-nginx /Teraz dodaj obrazy.
Obrazy
Możemy dodać obrazy prawie podobne do linków, dodając a! Przed każdym z nich muszę podkreślić, że nie mogę ich zobaczyć z terminala, a może nie bezpośrednio.! [tekst alternatywny] (adres-obrazu)Możemy użyć tych samych opcji linków, jeśli chcemy, aby było to bardziej zorganizowane.
Tablice
Zazwyczaj dane dostępowe umieszczam w tabelach serwerów lub usług.
W tym celu rysujemy linie tabeli za pomocą rurek (|) oddzielających kolumny i łączników (-) oddzielających nagłówek od reszty wierszy:| Usługa | Użytkownik | Klucz | | ------------- | --------- | ----------- | | FTP | solvetic | aw-D.wak | | SSH | admin | 2 -.- jestem, |Mielibyśmy coś takiego:
Rury nie muszą być wyrównane, a „krawędzie” są opcjonalne, na przykład:Pozycja 1 | Nagłówek 2 --- | --- spróbujmy | coś spróbujmy | coś innego. Spowoduje to wygenerowanie tej samej tabeli.Możesz również wyrównać tekst w swoich kolumnach, umieszczając symbol dwukropka ( na separatorze utworzonym z łącznika po stronie, którą chcesz wyrównać:| Wyrównanie do lewej. | Wyśrodkowany | Wyrównany do prawej. | |: ------------------- |: --------: | ----------------- -: | | test | test | test |Nie wszyscy redaktorzy akceptują tabele w Markdown.
Kod
Możemy wyróżnić nasz kod za pomocą przecen i różni się on w zależności od języka.Składnia potrójnego zaznaczenia
Umieszczenie tego typu bloków jest bardzo proste, wystarczy dołączyć blok kodu, który chcemy wprowadzić.e 3 backticki (`` ``) po którym następuje nazwa języka, do którego należy kod, który chcesz umieścić:`` `język x = y …` ``Przykładowy kod JavaScript wyglądałby mniej więcej tak:`` `` test funkcji js () {console.log ('testowanie!')} ''To wygenerowałoby ładny blok kodu ze składnią podświetloną dla javascript:test funkcji () {console.log ('testowanie!')}Składnia z odstępami wstępnymi
Innym sposobem na umieszczenie wstępnie sformatowanego tekstu lub kodu, ale bez określonego języka, jest „wcięcie” naszego tekstu 4 spacjami, napisalibyśmy to tak:x = y // zauważ, że między marginesem a tym, co piszemy, są 4 spacje.uzyskamy ten wynik:x = y // zauważ, że między marginesem a tym, co piszemy, są 4 spacje.Norma akceptuje tylko opcję z preparacją.
WnioskiDobry system dokumentacji musi być szybki, elastyczny i prosty. Punkty, które przecena pokrywa w bardzo dobry sposób, nie możemy zapomnieć o jego czystej składni dla oczu, co należy wziąć pod uwagę, jeśli chcemy przeglądać dokumentację z terminala za pomocą VIM / EMACS. Wpis ma podejście dla administratorów systemu, ale może być bardzo przydatny dla wszystkich typów profesjonalistów lub studentów.Mam nadzieję, że wszelkie wątpliwości lub sugestie zostały wyjaśnione, zostaw to w komentarzach.Podobał Ci się i pomógł ten samouczek?Możesz nagrodzić autora, naciskając ten przycisk, aby dać mu pozytywny punkt