Markdown is een lichtgewicht en eenvoudig te gebruiken syntaxis voor het stylen van alle vormen van schrijven op het GitHub platform.
wat u zult leren:
- Hoe het Markdown-formaat stijlvolle collaboratieve bewerking eenvoudig maakt
- Hoe Markdown verschilt van traditionele opmaakbenaderingen
- Hoe Markdown te gebruiken om tekst op te maken
- Hoe gebruik te maken van GitHub ’s automatische Markdown rendering
- Hoe GitHub’ s unieke Markdown extensies
Wat is Markdown?
Markdown is een manier om tekst op het web te stylen., U controleert de weergave van het document; het formatteren van woorden als vet of cursief, het toevoegen van afbeeldingen en het maken van lijsten zijn slechts een paar van de dingen die we kunnen doen met Markdown. Meestal is Markdown gewoon gewone tekst met een paar niet-alfabetische tekens, zoals #
of *
.,
U kunt Markdown gebruiken de meeste plaatsen rond GitHub:
- Gists
- opmerkingen in Issues en Pull Requests
- bestanden met de
.md
of.markdown
extensie
voor meer informatie, zie “Writing on GitHub” in de GitHub help.
voorbeelden
- tekst
- lijsten
- afbeeldingen
- Headers & aanhalingstekens
- Code
- Extra ‘ s
Syntaxgids
Hier is een overzicht van Markdown syntaxis die u overal kunt gebruiken GitHub.com of in je eigen tekstbestanden.,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 maakt gebruik van zijn eigen versie van de Markdown syntaxis die een extra set van handige functies biedt, waarvan veel het gemakkelijker maken om te werken met inhoud op GitHub.com.
merk op dat sommige functies van GitHub Flavored Markdown alleen beschikbaar zijn in de beschrijvingen en opmerkingen van Issues en Pull Requests. Deze omvatten @vermeldingen en verwijzingen naar SHA-1 hashes, Issues en Pull Requests. Takenlijsten zijn ook beschikbaar in Gist opmerkingen en in gist Markdown bestanden.,
Syntax highlighting
Hier is een voorbeeld van hoe u kunt gebruik maken van syntax highlighting met GitHub Smaak Markdown:
```javascriptfunction fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) }}```
Je kan ook gewoon streepje uw code door vier ruimtes:
function fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) } }
Hier is een voorbeeld van de Python-code zonder accentuering van de syntaxis:
def foo(): if not bar: return True
takenlijst
Als u een lijst met taken in de eerste reactie van een Probleem, u krijgt een handige voortgangsindicator in uw issue-lijst. Het werkt ook in Pull Requests!,parating elke kolom met een pijp |
:
Zou worden:
Eerste Koptekst | Tweede Header |
---|---|
Inhoud van cel 1 | Inhoud van cel 2 |
Inhoud in de eerste kolom | Inhoud van de in de tweede kolom |
SHA verwijzingen
een verwijzing naar een commit ‘ s SHA-1 hash wordt automatisch omgezet in een link naar de commit op GitHub.,
16c999e8c71134401a78d4d46435517b2271d6acmojombo@16c999e8c71134401a78d4d46435517b2271d6acmojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac
Issue references binnen een repository
elk nummer dat verwijst naar een Issue of Pull Request wordt automatisch omgezet in een link.
#1mojombo#1mojombo/github-flavored-markdown#1
gebruikersnaam @mentions
door een @
symbool te typen, gevolgd door een gebruikersnaam, wordt die persoon gewaarschuwd om de opmerking te komen bekijken. Dit heet een “@ mention”, omdat je het individu noemt. U kunt ook @vermelden teams binnen een organisatie.,
automatisch koppelen voor url ‘ s
elke URL (zoals ) wordt automatisch omgezet in een klikbare link.
Doorhalen
elk woord dat met twee tildes is omwikkeld (zoals ~~this~~
) wordt doorgestreept.
Emoji
GitHub ondersteunt emoji!
om een lijst te zien van elke afbeelding die we ondersteunen, kijk dan op het Emoji spiekbriefje.
Laatst bijgewerkt 15 Jan 2014