GitHub flavoured Markdown - freakimkaefig/Music-XML-Analyzer GitHub Wiki
Text
GitHub wandelt nicht sofort jeden Zeilenumbruch im Editor auch in einen wirklichen Zeilenumbruch um. Während Absätze durch Leerzeilen getrennt werden, wird eine neue Zeile durch Einfügen von zwei Leerzeichen am Ende der Zeile erzwungen.
Code Snippets
Einzeilige Codepassagen
Einfache einzeilige Codepassagen können mit einfache Backticks umschlossen werden:
`Hello World!`
ergibt:
Hello World!
Mehrzeilige Codepassagen
Für längere Codepassagen über mehrere Zeilen wird der Code von jeweils drei Backticks umschlossen:
```
var hello = function() {
console.log("Hello World!")
}
```
ergibt:
var hello = function() {
console.log("Hello World!")
}
Syntax-Highlighting
Für Syntax-Highlighting wird an die Backticks die jeweilige Sprache angehängt:
```javascript
var hello = function() {
console.log("Hello World!")
}
```
ergibt:
var hello = function() {
console.log("Hello World!")
}
Task Lists
In GitHub lassen sich durch hinzufügen von [ ]
und [x]
einfache Tasklisten erstellen, die anschließend als Checkboxen ausgegeben werden.
Dieses Beispiel:
- [x] Task 1
- [x] Subtask 1
- [ ] Subtask 2
- [ ] Task 2
- [ ] Task 3
- [ ] Subtask 1
- [ ] Subtask 2
erzeugt folgende Ausgabe:
- Task 1
- Subtask 1
- Subtask 2
- Task 2
- Task 3
- Subtask 1
- Subtak 2
Tabellen
First Header | Second Header
------------- | -------------
Content Cell | Content Cell
Content Cell | Content Cell
ergibt:
First Header | Second Header |
---|---|
Content Cell | Content Cell |
Content Cell | Content Cell |
Nachlese
- GitHub Flavoured Markdown - User Documentation (https://help.github.com/articles/github-flavored-markdown/)
- Writing on GitHub - User Documentation (https://help.github.com/articles/writing-on-github/)