Skip to content

Instantly share code, notes, and snippets.

@pavel-a
Created September 17, 2015 01:14
Show Gist options
  • Select an option

  • Save pavel-a/ddc7d7736b488680b850 to your computer and use it in GitHub Desktop.

Select an option

Save pavel-a/ddc7d7736b488680b850 to your computer and use it in GitHub Desktop.
Autorun.inf file for USB drives . Shows custom label in Windows explorer (some Linuxes too)
[AutoRun]
label=RETURN TO ME!
[IgnoreContentPaths]
*
@cezary13k
Copy link
Copy Markdown

Podstawowa składnia pisania i formatowania

Twórz wyrafinowane formatowanie dla swojej prozy i kodu w serwisie GitHub, stosując prostą składnię.

Nagłówki

Aby utworzyć nagłówek, dodaj od jednego do sześciu symboli # przed tekstem nagłówka. Liczba użytych symboli # określi poziom hierarchii i rozmiar czcionki nagłówka.

# Nagłówek pierwszego poziomu
## Nagłówek drugiego poziomu
### Nagłówek trzeciego poziomu

Zrzut ekranu wyrenderowanego kodu GitHub Markdown pokazujący przykładowe nagłówki h1, h2 i h3, których rozmiar czcionki i grubość wizualna maleją, aby pokazać poziom hierarchii.

Jeśli używasz dwóch lub więcej nagłówków, GitHub automatycznie generuje spis treści, do którego możesz uzyskać dostęp, klikając w nagłówku pliku. Każdy tytuł nagłówka jest wymieniony w spisie treści, a kliknięcie tytułu umożliwia przejście do wybranej sekcji.

Zrzut ekranu pliku README z wyświetlonym menu rozwijanym spisu treści. Ikona spisu treści jest zaznaczona ciemnopomarańczowym konturem.

Stylizacja tekstu

W polach komentarzy i plikach .md możesz wskazać wyróżnienie za pomocą pogrubienia, kursywy, przekreślenia, indeksu dolnego lub indeksu górnego.

Styl Składnia Skrót klawiaturowy Przykład Wyjście
Pogrubienie ** ** lub __ __ Command+B (Mac) lub Ctrl+B (Windows/Linux) **To jest pogrubiony tekst** To jest pogrubiony tekst
Kursywa * * lub _ _ Command+I (Mac) lub Ctrl+I (Windows/Linux) _Ten tekst jest pisany kursywą_ Ten tekst jest pisany kursywą
Przekreślenie ~~ ~~ lub ~ ~ Brak ~~To był błędny tekst~~ To był błędny tekst
Pogrubienie i zagnieżdżona kursywa ** ** i _ _ Brak **Ten tekst jest _niezwykle_ ważny** Ten tekst jest niezwykle ważny
Wszystko pogrubione i kursywa *** *** Brak ***Cały ten tekst jest ważny*** Cały ten tekst jest ważny
Indeks dolny <sub> </sub> Brak To jest tekst w <sub>indeksie dolnym</sub> To jest tekst w indeksie dolnym
Indeks górny <sup> </sup> Brak To jest tekst w <sup>indeksie górnym</sup> To jest tekst w indeksie górnym
Podkreślenie <ins> </ins> Brak To jest <ins>podkreślony</ins> tekst To jest podkreślony tekst

Cytowanie tekstu

Możesz cytować tekst za pomocą >.

Tekst, który nie jest cytatem

> Tekst będący cytatem

Cytowany tekst jest wcięty pionową linią z lewej strony i wyświetlany przy użyciu szarej czcionki.

Zrzut ekranu wyrenderowanego kodu GitHub Markdown pokazujący różnicę między tekstem normalnym a cytowanym.

[!UWAGA]
Podczas przeglądania konwersacji możesz automatycznie cytować tekst w komentarzu, zaznaczając go i wpisując R. Możesz zacytować cały komentarz, klikając , a następnie Zacytuj odpowiedź. Aby uzyskać więcej informacji o skrótach klawiaturowych, zobacz Skróty klawiaturowe.

Cytowanie kodu

Możesz wpisywać kod lub polecenie w zdaniu za pomocą pojedynczych znaków apostrofu. Tekst w tych znakach nie będzie formatowany. Możesz również nacisnąć skrót klawiaturowy Command+E (Mac) lub Ctrl+E (Windows/Linux), aby wstawić znaki apostrofu w bloku kodu w wierszu kodu Markdown.

Użyj polecenia `git status`, aby wyświetlić listę wszystkich nowych lub zmodyfikowanych plików, które nie zostały jeszcze zatwierdzone.

Zrzut ekranu wyrenderowanego kodu GitHub Markdown pokazujący, że znaki otoczone znakami odwrotnego apostrofu są wyświetlane czcionką o stałej szerokości i wyróżnione jasnoszarym kolorem.

Aby sformatować kod lub tekst w osobnym bloku, należy użyć potrójnego znaku apostrofu.

Oto kilka podstawowych poleceń Gita:
```
status git
dodaj git
zatwierdzenie git
```

Zrzut ekranu wyrenderowanego kodu GitHub Markdown pokazujący prosty blok kodu bez podświetlania składni.

Aby uzyskać więcej informacji, zobacz Tworzenie i zaznaczanie bloków kodu.

Jeśli często edytujesz fragmenty kodu i tabele, możesz skorzystać z włączenia czcionki o stałej szerokości we wszystkich polach komentarzy na GitHubie. Więcej informacji znajdziesz w artykule O pisaniu i formatowaniu na GitHubie.

Obsługiwane modele kolorów

W zgłoszeniach, żądaniach ściągnięcia i dyskusjach możesz oznaczać kolory w zdaniu, używając znaków odwrotnego apostrofu. Obsługiwany model kolorów w znakach odwrotnego apostrofu wyświetli wizualizację koloru.

Kolor tła to `#ffffff` w trybie jasnym i `#000000` w trybie ciemnym.

Zrzut ekranu wyrenderowanego kodu GitHub Markdown pokazujący, jak wartości HEX w znakach odwrotnego apostrofu tworzą małe okręgi koloru, tutaj białe, a następnie czarne.

Oto aktualnie obsługiwane modele kolorów.

Kolor Składnia Przykład Wyjście
HEX `#RRGGBB` `#0969DA` Zrzut ekranu wyrenderowanego kodu GitHub Markdown pokazujący, jak wartość HEX #0969DA wyświetla się w niebieskim kółku.
RGB `rgb(R,G,B)` `rgb(9, 105, 218)` Zrzut ekranu wyrenderowanego kodu GitHub Markdown pokazujący, jak wartości RGB 9, 105, 218 są wyświetlane z niebieskim okręgiem.
HSL `hsl(H,S,L)` `hsl(212, 92%, 45%)` Zrzut ekranu wyrenderowanego kodu GitHub Markdown pokazujący, jak wartość HSL 212, 92%, 45% wyświetla się z niebieskim kółkiem.

[!UWAGA]

  • Obsługiwany model kolorów nie może mieć żadnych spacji na początku ani na końcu znaku odwrotnego apostrofu.
  • Wizualizacja koloru jest obsługiwana wyłącznie w przypadku zgłoszeń, żądań ściągnięcia i dyskusji.

Linki

Możesz utworzyć link w tekście, umieszczając tekst linku w nawiasach kwadratowych [ ], a następnie adres URL w nawiasach okrągłych ( ). Możesz również użyć skrótu klawiaturowego Command+K, aby utworzyć link. Po zaznaczeniu tekstu możesz wkleić adres URL ze schowka, aby automatycznie utworzyć link z zaznaczenia.

Możesz również utworzyć hiperłącze Markdown, zaznaczając tekst i używając skrótu klawiaturowego Command+V. Jeśli chcesz zastąpić tekst linkiem, użyj skrótu klawiaturowego Command+Shift+V.

Ta strona została stworzona przy użyciu [GitHub Pages](https://pages.github.com/).

Zrzut ekranu wyrenderowanego kodu GitHub Markdown pokazujący, jak tekst w nawiasach, „Strony GitHub”, wyświetla się jako niebieski hiperłącze.

[!UWAGA]
GitHub automatycznie tworzy linki, gdy w komentarzu znajdują się prawidłowe adresy URL. Więcej informacji znajdziesz w artykule Autolinkowane odnośniki i adresy URL.

Linki do sekcji

Można utworzyć bezpośredni link do dowolnej sekcji posiadającej nagłówek. Aby wyświetlić automatycznie wygenerowany punkt zaczepienia w renderowanym pliku, najedź kursorem na nagłówek sekcji, aby wyświetlić ikonę i kliknij ikonę, aby wyświetlić kotwicę w przeglądarce.

Zrzut ekranu pliku README repozytorium. Po lewej stronie nagłówka sekcji ikona linku jest zaznaczona ciemnopomarańczowym konturem.

Jeśli musisz określić punkt zakotwiczenia nagłówka w edytowanym pliku, możesz posłużyć się następującymi podstawowymi zasadami:

  • Litery są zamieniane na małe.
  • Spacje zastępuje się myślnikami (-). Wszelkie inne spacje i znaki interpunkcyjne są usuwane.
  • Usunięto spacje na początku i na końcu.
  • Formatowanie znaczników jest usuwane, pozostaje tylko zawartość (na przykład _italics_ staje się italics).
  • Jeżeli automatycznie wygenerowana kotwica dla nagłówka jest identyczna z wcześniejszą kotwicą w tym samym dokumencie, generowany jest unikatowy identyfikator poprzez dołączenie myślnika i automatycznie zwiększającej się liczby całkowitej.

Aby uzyskać bardziej szczegółowe informacje na temat wymagań dotyczących fragmentów URI, zobacz RFC 3986: Uniform Resource Identifier (URI): Generic Syntax, Section 3.5.

Poniższy blok kodu demonstruje podstawowe zasady generowania kotwic z nagłówków w renderowanej treści.

# Przykładowe nagłówki

## Sekcja przykładowa

## To będzie _Pomocna_ sekcja o greckiej literze Θ!
Nagłówek zawierający znaki niedozwolone we fragmentach, znaki UTF-8, dwie kolejne spacje między pierwszym i drugim słowem oraz formatowanie.

## Ten nagłówek nie jest unikalny w pliku

TEKST 1

## Ten nagłówek nie jest unikalny w pliku

TEKST 2

# Linki do przykładowych nagłówków powyżej

Link do przykładowej sekcji: [Tekst linku](#sample-section).

Link do przydatnej sekcji: [Tekst linku](#to-będzie-pomocna-sekcja-o-greckiej-literze-Θ).

Link do pierwszej nieunikalnej sekcji: [Tekst linku](#this-heading-is-not-unique-in-the-file).

Link do drugiej nieunikalnej sekcji: [Tekst linku](#this-heading-is-not-unique-in-the-file-1).

[!UWAGA]
Jeśli edytujesz nagłówek lub zmieniasz kolejność nagłówków z „identycznymi” punktami odniesienia, musisz także zaktualizować wszystkie łącza do tych nagłówków, ponieważ punkty odniesienia ulegną zmianie.

Linki względne

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

Link względny to link odnoszący się do bieżącego pliku. Na przykład, jeśli w katalogu głównym repozytorium znajduje się plik README, a w katalogu docs/CONTRIBUTING.md znajduje się inny plik, link względny do pliku CONTRIBUTING.md w pliku README może wyglądać następująco:

[Wytyczne dotyczące wkładu w ten projekt](docs/CONTRIBUTING.md)

GitHub automatycznie przekształci link względny lub ścieżkę do obrazu na podstawie gałęzi, w której aktualnie się znajdujesz, dzięki czemu link lub ścieżka zawsze będą działać. Ścieżka linku będzie względna do bieżącego pliku. Linki rozpoczynające się od / będą względne do katalogu głównego repozytorium. Możesz używać wszystkich operandów linków względnych, takich jak ./ i ../.

Tekst linku powinien mieścić się w jednym wierszu. Poniższy przykład nie będzie działać.

[Składka
wytyczne dla tego projektu](docs/CONTRIBUTING.md)

Linki względne są łatwiejsze w użyciu dla użytkowników klonujących Twoje repozytorium. Linki bezwzględne mogą nie działać w klonach Twojego repozytorium – zalecamy używanie linków względnych do odwoływania się do innych plików w Twoim repozytorium.

Niestandardowe kotwice

Możesz użyć standardowych znaczników zakotwiczenia HTML (<a name="unique-anchor-name"></a>), aby utworzyć punkty zakotwiczenia nawigacji dla dowolnego miejsca w dokumencie. Aby uniknąć niejednoznacznych odniesień, zastosuj unikalny schemat nazewnictwa znaczników zakotwiczenia, na przykład dodając prefiks do wartości atrybutu name.

[!UWAGA]
Niestandardowe kotwice nie zostaną uwzględnione w konspekcie dokumentu/spisie treści.

Możesz utworzyć link do niestandardowej kotwicy, używając wartości atrybutu name nadanego kotwicy. Składnia jest dokładnie taka sama, jak w przypadku linkowania do kotwicy generowanej automatycznie dla nagłówka.

Na przykład:

# Nagłówek sekcji

Fragment tekstu tej sekcji.

<a name="my-custom-anchor-point"></a>
Chcę podać bezpośredni link do pewnego tekstu, ale nie ma on własnego nagłówka.

(…więcej treści…)

[Link do tego niestandardowego punktu zakotwiczenia](#my-custom-anchor-point)

[!WSKAZÓWKA]
Niestandardowe kotwice nie są brane pod uwagę podczas automatycznego nadawania nazw i numerowania automatycznych łączy nagłówków.

Podziały wierszy

Jeśli zgłaszasz problemy, prosisz o ściągnięcie lub piszesz dyskusje w repozytorium, GitHub automatycznie wyświetli podział wiersza:

Ten przykład
Będzie obejmować dwie linie

Jeśli jednak piszesz w pliku .md, powyższy przykład zostanie wyświetlony w jednym wierszu bez podziału wiersza. Aby utworzyć podział wiersza w pliku .md, musisz uwzględnić jeden z poniższych elementów:

  • Na końcu pierwszego wiersza należy dodać dwie spacje.

    Ten przykład
    Będzie obejmować dwie linie

  • Na końcu pierwszego wiersza należy umieścić ukośnik.

    Ten przykład\
    Będzie obejmować dwie linie
    
  • Umieść znacznik podziału pojedynczego wiersza HTML na końcu pierwszego wiersza.

    Ten przykład<br/>
    Będzie obejmować dwie linie
    

Jeśli pozostawisz pustą linię między dwoma wierszami, zarówno pliki .md, jak i Markdown w zgłoszeniach, żądaniach ściągnięcia i dyskusjach, spowodują, że dwa wiersze zostaną rozdzielone pustą linią:

Ten przykład

Będzie mieć pustą linię oddzielającą obie linie

Obrazy

Możesz wyświetlić obraz, dodając ! i umieszczając tekst alternatywny w nawiasach [ ]. Tekst alternatywny to krótki tekst odpowiadający informacjom zawartym na obrazku. Następnie umieść link do obrazka w nawiasach ().

![Zrzut ekranu komentarza w problemie na GitHubie przedstawiający dodany w Markdownie obraz uśmiechniętego i podnoszącego mackę ośmiornicy.](https://myoctocat.com/assets/images/base-octocat.svg)

Zrzut ekranu komentarza w problemie na GitHubie przedstawiający dodany w Markdownie obraz uśmiechniętego ośmiornicy podnoszącej mackę.

GitHub obsługuje osadzanie obrazów w zgłoszeniach, żądaniach ściągnięcia, dyskusjach, komentarzach i plikach .md. Możesz wyświetlić obraz z repozytorium, dodać link do obrazu online lub przesłać obraz. Więcej informacji znajdziesz w artykule Przesyłanie zasobów.

[!UWAGA]
Jeśli chcesz wyświetlić obraz znajdujący się w Twoim repozytorium, użyj linków względnych zamiast linków bezwzględnych.

Oto kilka przykładów wykorzystania linków względnych do wyświetlania obrazków.

Kontekst Link względny
W pliku .md na tej samej gałęzi /assets/images/electrocat.png
W pliku .md w innej gałęzi /../main/assets/images/electrocat.png
W zgłoszeniach, żądaniach ściągnięcia i komentarzach repozytorium ../blob/main/assets/images/electrocat.png?raw=true
W pliku .md w innym repozytorium /../../../../github/docs/blob/main/assets/images/electrocat.png
W zgłoszeniach, żądaniach ściągnięcia i komentarzach innego repozytorium ../../../github/docs/blob/main/assets/images/electrocat.png?raw=true

[!UWAGA]
Dwa ostatnie linki względne w tabeli powyżej będą działać w przypadku obrazów w prywatnym repozytorium tylko wtedy, gdy użytkownik ma przynajmniej dostęp do odczytu prywatnego repozytorium zawierającego te obrazy.

Więcej informacji znajdziesz w artykule Linki względne.

Element obrazu

Element HTML <picture> jest obsługiwany.

Listy

Można utworzyć listę nieuporządkowaną, poprzedzając jeden lub więcej wierszy tekstu znakiem -, * lub +.

- Cyber Cezary

Zrzut ekranu wyrenderowanego kodu GitHub Markdown przedstawiający wypunktowaną listę nazwisk trzech pierwszych prezydentów Stanów Zjednoczonych.

Aby uporządkować listę, poprzedź każdy wiersz numerem.

1. James Madison
2. James Monroe
3. John Quincy Adams

Zrzut ekranu wyrenderowanego kodu GitHub Markdown przedstawiający ponumerowaną listę imion czwartego, piątego i szóstego prezydenta Stanów Zjednoczonych.

Listy zagnieżdżone

Możesz utworzyć listę zagnieżdżoną poprzez wcięcie jednego lub kilku elementów listy pod innym elementem.

Aby utworzyć listę zagnieżdżoną za pomocą edytora internetowego w serwisie GitHub lub edytora tekstu obsługującego czcionkę o stałej szerokości, takiego jak Visual Studio Code, możesz wizualnie wyrównać listę. Wpisuj spacje przed elementem listy zagnieżdżonej, aż znak znacznika listy (- lub *) znajdzie się bezpośrednio pod pierwszym znakiem tekstu w elemencie nad nim.

1. Pierwszy element listy
   - Pierwszy zagnieżdżony element listy
     - Drugi element listy zagnieżdżonej

[!UWAGA]
W edytorze internetowym możesz wciąć lub usunąć jeden lub więcej wierszy tekstu, najpierw zaznaczając żądane wiersze, a następnie używając odpowiednio kombinacji klawiszy Tab lub Shift+Tab.

Zrzut ekranu języka Markdown w programie Visual Studio Code pokazujący wcięcia zagnieżdżonych wierszy numerowanych i punktorów.

![Zrzut ekranu wyrenderowanego kodu GitHub Markdown przedstawiający ponumerowany element, po którym następują zagnieżdżon

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment