Základní psaní a formátování syntaxe

Nadpisy

Pro vytvoření nadpisu, přidat jeden až šest # symboly, než váš text nadpisu. Číslo #, které používáte, určí velikost nadpisu.

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

Styling text

můžete uvést důraz s tučné, kurzíva, nebo přeškrtnutí textu.

citace textu

text můžete citovat pomocí >.,

In the words of Abraham Lincoln:> Pardon my French

citace kódu

můžete volat kód nebo příkaz ve větě s jednotlivými backticks. Text v backticks nebude formátován.,

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

formát kódu nebo textu do své vlastní odlišné blok, použijte triple ve zpětném apostrofu.

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

Více informací naleznete v části “ Vytváření a zvýraznění bloků kódu.“

Odkazy

můžete vytvořit vložený odkaz, v balení odkaz text v závorkách , a pak zabalení URL v závorkách ( ). K vytvoření odkazu můžete také použít klávesovou zkratku command + k.,

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

odkazy

můžete odkaz přímo na oddíl, ve vykreslení souboru tím, vznášející se nad nadpis sekce, vystavit odkaz:

Relativní odkazy

můžete definovat relativní odkazy a obraz cesty v tavené souborů, které pomáhají čtenáři orientovat na jiné soubory v repozitáři.,

relativní odkaz je odkaz, který je vzhledem k aktuálnímu souboru. Například, pokud máte soubor README v kořenovém adresáři repository, a máte jiný soubor v dokumenty/PŘISPÍVÁ.md, relativní odkaz PŘISPÍVAT.md ve vašem README může vypadat například takto:

(docs/CONTRIBUTING.md)

GitHub automaticky transformovat své relativní odkaz nebo obrázek cestě založené na cokoliv branch jste v současné době na, tak, že odkaz nebo cestu vždy funguje. Můžete použít všechny relativní link operandy, například ./ a ../.,

relativní odkazy jsou jednodušší pro uživatele, kteří klonují úložiště. Absolutní odkazy nemusí fungovat v klonech vašeho úložiště – doporučujeme použít relativní odkazy k odkazování na jiné soubory ve vašem úložišti.

Seznam

můžete Si vytvořit neuspořádaný seznam, který předchází jeden nebo více řádků textu pomocí - nebo *.

- George Washington- John Adams- Thomas Jefferson

Chcete, aby váš seznam, předcházet každý řádek s číslem.,

1. James Madison2. James Monroe3. John Quincy Adams

Vnořené Seznamy

můžete vytvořit vnořené seznam tím, že tlačí jednu nebo více položek seznamu níže další položky.

Chcete-li vytvořit vnořený seznam pomocí webového editoru na Githubu nebo textového editoru, který používá monospaced písmo, jako je Atom, můžete seznam vizuálně zarovnat. Zadejte znaky mezery před vnořenou položkou seznamu, dokud znak značky seznamu (- nebo *) leží přímo pod prvním znakem textu v položce nad ním.,

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

K vytvoření vnořeného seznamu v textovém editoru na GitHub, která nemá používat neproporcionální písma, můžete se podívat na položku v seznamu, který je bezprostředně nad vnořené seznam a spočítat počet znaků, které se zobrazí před obsahem položky. Poté zadejte tento počet znaků prostoru před vnořenou položkou seznamu.,

V tomto příkladu, můžete přidat vnořenou položku v seznamu pod položku seznamu 100. First list item odsazení vnořené položky seznamu minimálně pět míst, protože tam jsou pět znaků () před First list item.

100. First list item - First nested list item

můžete vytvořit více úrovní vnořených seznamů pomocí stejné metody., Například, protože první vnořená položka seznamu má sedm míst (␣␣␣␣␣-␣) před vnořené seznam obsah First nested list item, budete muset odrážka druhá vnořená položka seznamu o sedm míst.

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

další příklady, viz GitHub Ochucené Markdown Spec.

seznamy úloh

Chcete-li vytvořit seznam úloh, Předmluva seznam položek s pravidelným znakem prostoru následuje. Chcete-li označit úlohu jako úplnou, použijte .,

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

Pokud seznam úkolů, popis položky začíná závorky, musíte uniknout \:

- \(Optional) Open a followup issue

Pro více informací, viz „O seznamy úkolů.“

Zmínku, lidí a týmů

můžete zmínit osobu nebo tým na GitHub zadáním @ plus jejich uživatelské jméno nebo název týmu. To spustí oznámení a upozorní je na konverzaci., Lidé také obdrží oznámení, pokud upravíte komentář a uvedete své uživatelské jméno nebo název týmu. Další informace o oznámeních naleznete v části “ o oznámeních.“

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

Když jste zmínil rodiče tým, členové jeho dítě týmy také přijímat oznámení, zjednodušení komunikace s různými skupinami lidí. Pro více informací viz “ o týmech.“

zadáním symbolu@ se na projektu zobrazí seznam lidí nebo týmů., Seznam filtruje při psaní, takže jakmile najdete jméno osoby nebo týmu, který hledáte, můžete jej vybrat pomocí kláves se šipkami a stisknutím klávesy tab nebo enter dokončit jméno. Pro týmy zadejte název @organizace / týmu a všichni členové tohoto týmu se přihlásí k odběru konverzace.

výsledky automatického dokončování jsou omezeny na spolupracovníky úložiště a další účastníky vlákna.

Odkazování na otázky a žádosti pull

můžete vyvolat seznam navrhovaných problémů a vytáhněte žádostí v rámci úložiště zadáním #., Zadejte problém nebo vytáhněte číslo požadavku nebo název pro filtrování seznamu a poté stiskněte buď kartu nebo enter pro dokončení zvýrazněného výsledku.

Další informace naleznete v části “ Automatické odkazy a adresy URL.“

Odkazování na externí zdroje

Pokud vlastní autolink odkazy jsou nakonfigurován pro úložiště, pak odkazy na externí zdroje, jako JIRA vydání nebo Zendesk lístek, převést do zkrácené odkazy. Chcete-li vědět, které automatické odkazy jsou k dispozici ve vašem úložišti, kontaktujte někoho s oprávněními správce do úložiště., Další informace naleznete v části “ Konfigurace automatických odkazů pro odkaz na externí zdroje.“

přílohy obsahu

některé aplikace GitHub poskytují informace v GitHubu pro adresy URL, které odkazují na jejich registrované domény. GitHub vykresluje informace poskytnuté aplikací pod adresou URL v těle nebo komentuje problém nebo žádost o stažení.

Chcete-li zobrazit přílohy obsahu, musíte mít v úložišti nainstalovanou aplikaci GitHub, která používá API Content Attachments., Další informace naleznete v části „Instalace aplikace do vašeho osobního účtu“ a „instalace aplikace do vaší organizace.“

přílohy obsahu se nezobrazí pro adresy URL, které jsou součástí odkazu markdown.

pro více informací o vytvoření aplikace GitHub, která používá přílohy obsahu, viz “ použití příloh obsahu.“

pomocí emoji

můžete přidat emoji do psaní zadáním :EMOJICODE:.

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

Psaní : přinese až seznam navrhovaných emoji., Seznam bude filtrovat, jak píšete, takže jakmile najdete emoji, který hledáte, stiskněte kartu nebo Enter pro dokončení zvýrazněného výsledku.

úplný seznam dostupných emoji a kódů, podívejte se na Emoji-Cheat-Sheet.

odstavce

nový odstavec můžete vytvořit ponecháním prázdného řádku mezi řádky textu.

Ignoruje Markdown formátování

můžete říct, GitHub ignorovat (nebo útěk) Markdown formátování pomocí \ před Markdown charakter.,

Let's rename \*our-new-project\* to \*our-old-project\*.

Pro více informací, viz Daring Fireball „Markdown Syntaxe.“

Další čtení

• GitHub Ochucené Markdown Spec
• „O psaní a formátování na GitHub“
• „Práce s pokročilé formátování“
• „Zvládnutí Markdown“