Beispielkapitel
Frederick Lockemann |
---|
RWTH Aachen University |
lockemann@dbis.rwth-aachen.de |
1. Mathematische Formeln
Hier ist eine mathematische Formel \(1+1=3\).
In mathematischen Formeln in Markdown kann \(\LaTeX\) Code verwendet werden um kompliziertere Formeln zu verwenden, ein Beispiel:
\(\int_\Omega \nabla u \cdot \nabla v~dx = \int_\Omega fv~dx\)
2. Zitieren
Zitieren kann man so: (Gavin et al., 2006)
Dazu ist es nötig, dass die Referenzen im references.bib vorhanden sind.
3. Bilder
Ein Bild: Caption und Quelle
4. Kramdown
In den Abschnitten 1 bis 3 wurde nur Markdown Syntax verwendet.
Allerdings ist es möglich durch kramdown mehr als nur das Standard Markdown zu verwenden.
Kramdown wird beschrieben als:
kramdown (sic, not Kramdown or KramDown, just kramdown) is a free MIT-licensed Ruby library for parsing and converting a superset of Markdown. It is completely written in Ruby, supports standard Markdown (with some minor modifications) and various extensions that have been made popular by the PHP Markdown Extra package and Maruku.
4.1 Tabellen
Tabellen können mit Markdown so gemacht werden:
Table: Your Caption
Default aligned | Left aligned | Center aligned | Right aligned |
---|---|---|---|
First body part | Second cell | Third cell | fourth cell |
Second line | foo | strong | baz |
Third line | quux | baz | bar |
Second body | |||
2 line | |||
Footer row |
Mit kramdown kann man Styles zu Elementen wie Tabellen hinzufügen.
Dazu wird der Style in einer .scss Datei festgelegt.
Hier ist der relevante Ausschnitt aus der _base.scss:
.mbtablestyle {
border-collapse: collapse;
> table, td, th {
border: 2px solid black;
}
}
Hier ist das Ergebnis zu sehen:
Table: Your Caption
Default aligned | Left aligned | Center aligned | Right aligned |
---|---|---|---|
First body part | Second cell | Third cell | fourth cell |
Second line | foo | strong | baz |
Third line | quux | baz | bar |
Second body | |||
2 line | |||
Footer row |
Für Tabellen ist es wichtig eine Zeile über und unter der Tabelle freizulassen, damit die Tabelle auch compiled wird.
5. Videos
Generell wird eine Markdown oder kramdown Datei in HTML Code umgewandelt und in einigen Fällen kann man genau hiervon profitieren. Dinge wie Videos in Kapitel einbinden kann nicht durch pures Markdown oder kramdown gemacht werden. Jedoch kann man HTML Blöcke einfügen und so spezielle Wünsche umsetzen, hier seht ihr ein Beispiel:
Dazu kann man den Einbettungscode, also den iframe Tag ersetzen. Es ist jedoch darauf zu achten, dass das Einbetten von Videos, das Erstellen des Onlinebuches länger braucht.
6. Visualisierung
6.1 Force Graph
6.2 Spider Web Diagram
6.3 Beispiel
Weiterer Syntax
Hier sind noch mehr Syntax Anleitungen für Markdown.
Hier sind noch mehr Syntax Anleitungen für kramdown.
Referenzen
- Gavin, A.-C., Aloy, P., Grandi, P., Krause, R., Boesche, M., Marzioch, M., Rau, C., Jensen, L. J., Bastuck, S., Dümpelfeld, B., Edelmann, A., Heurtier, M.-A., Hoffman, V., Hoefert, C., Klein, K., Hudak, M., Michon, A.-M., Schelder, M., Schirle, M., … Superti-Furga, G. (2006). Proteome survey reveals modularity of the yeast cell machinery. Nature, 440(7084), 631–636. https://doi.org/10.1038/nature04532