Podstawowa składnia zapisu i formatowania

nagłówki

aby utworzyć nagłówek, dodaj jeden do sześciu # symbole przed tekstem nagłówka. Numer#, którego używasz, określi rozmiar nagłówka.

# The largest heading## The second largest heading###### The smallest heading

tekst stylizacji

można zaznaczyć podkreślenie pogrubionym, kursywą lub przekreślonym tekstem.

cytowanie tekstu

możesz cytować tekst za pomocą>.,

In the words of Abraham Lincoln:> Pardon my French

cytowanie kodu

możesz wywołać kod lub polecenie w zdaniu za pomocą pojedynczych zwrotek. Tekst w backtickach nie zostanie sformatowany.,

Use `git status` to list all new or modified files that haven't yet been committed.

aby sformatować kod lub tekst do własnego oddzielnego bloku, użyj potrójnych backtików.

Some basic Git commands are:```git statusgit addgit commit```

aby uzyskać więcej informacji, zobacz „Tworzenie i podświetlanie bloków kodu.”

linki

możesz utworzyć łącze w nawiasie, owijając tekst łącza w nawias, a następnie owijając adres URL w nawiasach ( ). Możesz również użyć skrótu klawiaturowego command + k, aby utworzyć łącze.,

This site was built using (https://pages.github.com/).

linki do sekcji

możesz połączyć się bezpośrednio z sekcją w renderowanym pliku, najeżdżając kursorem na nagłówek sekcji, aby wyświetlić link:

linki względne

Możesz zdefiniować linki względne i ścieżki obrazów w renderowanych plikach, aby ułatwić czytelnikom nawigację do innych plików w repozytorium.,

odnośnik względny jest odnośnikiem względem bieżącego pliku. Na przykład, jeśli Masz plik README w katalogu głównym repozytorium, a masz inny plik w pliku docs/CONTRIBUTING.md, odnośnik do CONTRIBUTING.md w Twoim README może wyglądać tak:

(docs/CONTRIBUTING.md)

GitHub automatycznie przekształci Twój odnośnik lub ścieżkę do obrazu w zależności od gałęzi, na której aktualnie się znajdujesz, tak aby link lub ścieżka zawsze działały. Możesz użyć wszystkich względnych operandów łącza, takich jak ./ I ../.,

linki względne są łatwiejsze dla użytkowników, którzy sklonują Twoje repozytorium. Łącza bezwzględne mogą nie działać w Klonach repozytorium – zalecamy używanie łączy względnych do odwoływania się do innych plików w repozytorium.

listy

możesz utworzyć nieuporządkowaną listę poprzedzając jedną lub więcej linii tekstu za pomocą- lub*.

- George Washington- John Adams- Thomas Jefferson

aby zamówić listę, poprzedź każdą linię numerem.,

1. James Madison2. James Monroe3. John Quincy Adams

zagnieżdżone listy

możesz utworzyć zagnieżdżoną listę, wciskając jeden lub więcej elementów listy poniżej innego elementu.

aby utworzyć zagnieżdżoną listę za pomocą edytora www na GitHub lub edytora tekstu, który używa czcionek jednoprzestrzennych, takich jak Atom, możesz wyrównać listę wizualnie. Wpisz znaki spacji przed zagnieżdżonym elementem listy, aż znak znacznika listy (- lub *) znajduje się bezpośrednio pod pierwszym znakiem tekstu w elemencie nad nim.,

1. First list item - First nested list item - Second nested list item

aby utworzyć zagnieżdżoną listę w edytorze komentarzy na Githubie, który nie używa czcionki monospaced, możesz spojrzeć na pozycję listy bezpośrednio nad zagnieżdżoną listą i policzyć liczba znaków, które pojawiają się przed zawartością elementu. Następnie wpisz tę liczbę znaków spacji przed zagnieżdżonym elementem listy.,

w tym przykładzie można dodać zagnieżdżoną pozycję listy pod pozycją 100. First list itempoprzez wcięcie zagnieżdżonej pozycji listy minimum pięciu spacji, ponieważ jest pięć znaków () przed First list item.

100. First list item - First nested list item

za pomocą tej samej metody można utworzyć wiele poziomów zagnieżdżonych list., Na przykład, ponieważ pierwszy zagnieżdżony element listy ma siedem spacji (␣␣␣␣␣-␣) przed zagnieżdżoną zawartością listy First nested list item, trzeba by wciąć drugi zagnieżdżony element listy o siedem spacji.

100. First list item - First nested list item - Second nested list item

więcej przykładów znajdziesz w specyfikacji Github Flavored Markdown.

listy zadań

aby utworzyć listę zadań, przedrostek listy elementów ze zwykłym znakiem spacji, po którym następuje . Aby oznaczyć zadanie jako ukończone, użyj .,

- Finish my changes- Push my commits to GitHub- Open a pull request

Jeśli opis elementu listy zadań zaczyna się od nawiasu, musisz go usunąć za pomocą \:

- \(Optional) Open a followup issue

aby uzyskać więcej informacji, zobacz „o listach zadań.”

Wymienianie osób i zespołów

możesz wymienić osobę lub zespół na Githubie, wpisując@ oraz ich nazwę użytkownika lub nazwę zespołu. Spowoduje to uruchomienie powiadomienia i zwróci ich uwagę na rozmowę., Osoby otrzymają również powiadomienie, jeśli edytujesz komentarz, aby podać ich nazwę użytkownika lub nazwę zespołu. Aby uzyskać więcej informacji na temat powiadomień, Zobacz „informacje o powiadomieniach.”

@github/support What do you think about these updates?

gdy wspomnisz o zespole nadrzędnym, członkowie jego zespołów podrzędnych otrzymują również powiadomienia, co upraszcza komunikację z wieloma grupami osób. Aby uzyskać więcej informacji, zobacz „o zespołach.”

wpisanie symbolu @ spowoduje wyświetlenie listy osób lub zespołów w projekcie., Lista filtruje się podczas wpisywania, więc po znalezieniu nazwy osoby lub zespołu, którego szukasz, możesz użyć klawiszy strzałek, aby ją wybrać i nacisnąć kartę lub enter, aby uzupełnić nazwę. W przypadku zespołów wprowadź nazwę @ organization/team-name, a wszyscy członkowie tego zespołu otrzymają subskrypcję rozmowy.

wyniki autouzupełniania są ograniczone do współpracowników repozytorium i innych uczestników w wątku.

odwoływanie się do spraw i żądań pobierania

możesz wyświetlić listę sugerowanych spraw i żądań pobierania w repozytorium, wpisując #., Wpisz numer sprawy lub numer żądania lub tytuł, aby przefiltrować listę, a następnie naciśnij klawisz tab lub enter, aby zakończyć podświetlony wynik.

aby uzyskać więcej informacji, zobacz „Automatyczne odnośniki i adresy URL.”

odwoływanie się do zasobów zewnętrznych

Jeśli niestandardowe odniesienia autolink są skonfigurowane dla repozytorium, odniesienia do zasobów zewnętrznych, takich jak problem JIRA lub Zendesk ticket, przekształcają się w skrócone łącza. Aby dowiedzieć się, które autolinki są dostępne w Twoim repozytorium, skontaktuj się z kimś z uprawnieniami administratora do repozytorium., Aby uzyskać więcej informacji, zobacz ” Konfigurowanie autolinków w celu odwoływania się do zasobów zewnętrznych.”

załączniki treści

niektóre aplikacje GitHub dostarczają w GitHub informacji o adresach URL, które prowadzą do ich zarejestrowanych domen. GitHub renderuje informacje dostarczone przez aplikację pod adresem URL w treści lub komentarzu sprawy lub żądania pull.

aby zobaczyć załączniki zawartości, musisz mieć zainstalowaną w repozytorium aplikację GitHub, która używa interfejsu API załączników zawartości., Aby uzyskać więcej informacji, zobacz „Instalowanie aplikacji na koncie osobistym” i ” instalowanie aplikacji w organizacji.”

załączniki zawartości nie będą wyświetlane dla adresów URL, które są częścią łącza znacznika.

aby uzyskać więcej informacji na temat tworzenia aplikacji GitHub, która używa załączników zawartości, zobacz „Używanie załączników zawartości.”

używając emoji

możesz dodać emoji do swojego pisania wpisując :EMOJICODE:.

@octocat :+1: This PR looks great - it's ready to merge! :shipit:

wpisując : wyświetli listę sugerowanych emoji., Lista będzie filtrowana podczas pisania, więc po znalezieniu emoji, której szukasz, naciśnij klawisz Tab lub Enter, aby zakończyć podświetlony wynik.

aby uzyskać pełną listę dostępnych emoji i kodów, sprawdź Emoji-Cheat-Sheet.

akapity

możesz utworzyć nowy akapit, pozostawiając pustą linię między wierszami tekstu.

ignorowanie formatowania znaczników

możesz powiedzieć GitHub, aby ignorował (lub unikał) formatowania znaczników, używając\ przed znakiem znaczników.,w grze Daring Fireball nie ma żadnych ograniczeń co do tego, czy są one dostępne w grze, czy też nie.”

dalsza lektura

• Github Markdown Spec
• „o pisaniu i formatowaniu na Githubie”
• „praca z zaawansowanym formatowaniem”
• „Mastering Markdown”