Markdown jest lekką i łatwą w użyciu składnią do stylizacji wszystkich form pisania na platformie GitHub.
czego się nauczysz:
- jak format Markdown ułatwia edytowanie w trybie współpracy
- czym Markdown różni się od tradycyjnych metod formatowania
- Jak używać Markdown do formatowania tekstu
- jak wykorzystać automatyczne renderowanie znaczników na Githubie
- Jak zastosować unikalne rozszerzenia Markdown na Githubie
Co to jest Markdown?
Markdown to sposób na stylizację tekstu w sieci., Możesz kontrolować wyświetlanie dokumentu; formatowanie słów jako pogrubienie lub kursywa, dodawanie obrazów i tworzenie list to tylko niektóre z rzeczy, które możemy zrobić z Markdown. Zazwyczaj Markdown to zwykły tekst z kilkoma nie-alfabetycznymi znakami, jak #
lub *
.,
Możesz używać Markdown w większości miejsc wokół Githuba:
- Gists
- komentarze w sprawach i żądania pobierania
- pliki z
.md
lub.markdown
aby uzyskać więcej informacji, zobacz „Pisanie na Githubie” w sekcji Pomoc Githuba.
przykłady
- tekst
- listy
- obrazy
- nagłówki & cudzysłowy
- Kod
- Dodatki
Przewodnik po składni
oto przegląd składni Markdown, której możesz użyć w dowolnym miejscu na stronie GitHub.com lub we własnych plikach tekstowych.,3>Headers
# This is an <h1> tag## This is an <h2> tag###### This is an <h6> tag
Emphasis
*This text will be italic*_This will also be italic_**This text will be bold**__This will also be bold___You **can** combine them_
Lists
Unordered
* Item 1* Item 2 * Item 2a * Item 2b
Ordered
1. Item 11. Item 21. Item 3 1. Item 3a 1. Item 3b
Images
!(/images/logo.png)Format: !(url)
Links
http://github.com - automatic!(http://github.com)
Blockquotes
As Kanye West said:> We're living the future so> the present is our past.
Inline code
I think you should use an`<addr>` element here instead.
GitHub Flavored Markdown
GitHub.,com wykorzystuje własną wersję składni Markdown, która zapewnia dodatkowy zestaw przydatnych funkcji, z których wiele ułatwia pracę z treścią na GitHub.com.
zauważ, że niektóre funkcje GitHub są dostępne tylko w opisach i komentarzach spraw i żądań Pull. Należą do nich wzmianki@, a także odniesienia do skrótów SHA-1, spraw i żądań pobierania. Listy zadań są również dostępne w komentarzach Gist oraz w plikach Gist Markdown.,
podświetlanie składni
oto przykład jak możesz używać podświetlania składni z GitHub Flavored Markdown:
```javascriptfunction fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) }}```
Możesz również po prostu wciąć swój kod o cztery spacje:
function fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) } }
oto przykład kodu Pythona bez podświetlania składni:
def foo(): if not bar: return True
listy zadań
jeśli dodasz listę zadań do pierwszego komentarza sprawy, otrzymasz przydatny wskaźnik postępu na liście spraw. Działa również w Pull Requests!,paraowanie każdej kolumny za pomocą rury |
:
stałoby się:
pierwszy nagłówek | drugi nagłówek |
---|---|
zawartość z komórki 1 | zawartość z komórki 2 |
zawartość w pierwszej kolumnie | zawartość w drugiej kolumnie |
odniesienia do SHA
wszelkie odniesienia do skrótu SHA-1 commita zostaną automatycznie przekonwertowane na link do tego commita na GitHubie.,
16c999e8c71134401a78d4d46435517b2271d6acmojombo@16c999e8c71134401a78d4d46435517b2271d6acmojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac
odwołania do spraw w repozytorium
każdy numer, który odnosi się do sprawy lub żądania pobierania, zostanie automatycznie zamieniony na link.
#1mojombo#1mojombo/github-flavored-markdown#1
nazwa użytkownika @wspomina
wpisanie symbolu @
, po którym następuje nazwa użytkownika, powiadomi tę osobę, aby przyszła i zobaczyła komentarz. To się nazywa „@ wzmianka”, ponieważ wspominasz osobę. Możesz również wspomnieć o zespołach w organizacji.,
Automatyczne łączenie adresów URL
dowolny adres URL (np.) zostanie automatycznie zamieniony na klikalny link.
Strikethrough
każde słowo zawinięte dwoma tyldami (np. ~~this~~
) pojawi się przekreślone.
Emoji
GitHub obsługuje emoji!
aby zobaczyć listę wszystkich obsługiwanych przez nas obrazów, sprawdź ściągawkę Emoji.
Ostatnia aktualizacja: 15.01.09