Acrolinx unterstützt GitHub-flavored Markdown (GFM) und CommonMark.
Wie Acrolinx Elemente extrahieren soll, definieren Sie in Ihrem Content-Profil für Markdown unter Extraktion.
Wir verwenden HTML-Elementnamen oder Attributnamen, um Markdown-Elemente zu identifizieren. Der Elementname für eine Überschrift der 2. Ebene ist z. B. h2.
Weitere Einzelheiten finden Sie im GitHub-flavored Markdown Spec oder CommonMark Spec.
Für Markdown, der kein klar korrespondierendes HTML hat, haben wir eine Liste mit den spezifischen Markdown-Elementnamen erstellt.
h2
Der folgende Markdown ist identifiziert mit dem Elementnamen h2
:
## I'm a level-two heading So am I -------- <h2>And me too</h2>
a.title
Der folgende Markdown ist mit dem Elementnamen a
und dem zu extrahierenden Attribut title
identifiziert:
-
My alternative title
-
My other alternative title
Scored by [Acrolinx](https://www.acrolinx.com "My alternative title"). Visit <a href="https://www.acrolinx.com" title="My other alternative title">Acrolinx</a>.
Zusätzlich zu den HTML-Elementen, die Sie verwenden können, finden Sie hier eine Liste von Markdown-spezifischen Elementen und Attributen, die für Ihr Markdown-Content-Profil nützlich sein können.
codeblock
Der folgende Markdown ist identifiziert mit dem Elementnamen codeblock
:
-
code1
-
code2
-
code3
Nutzen Sie das Attribut title
, um „myTitle“ zu identifizieren.
The following code1-line is indented by a tab: code1 ```myTitle code2 ``` ~~~~~~~~~~~~~~~~~~~~ code3 ~~~~~~~~~~~~~~~~~~~~
Autolinks (al)
Autolinks („http://www.example.com“ im folgenden Markdown-Dokument) sind mit dem Element al
und dem Attribut al.href
identifiziert.
Visit our <http://www.example.com> website!
Email-Autolinks (ml)
Email-Autolinks („mail@example.com“ im folgenden Markdown-Dokument) sind mit dem Element ml
identifiziert.
Contact <mail@example.com>.
YAML Front Matter (yfm)
Identifizieren Sie den folgenden Markdown als YAML Front Matter Block mit dem Elementnamen yfm
:
--- name: Miyamoto Musashi age: young contact: email: email@domain.com address: some location pets: - cat - dog - bat match: !!js/regexp /pattern/gim run: !!js/function function() { } ---
xref
Element a
und img
haben ein neues xref
-Attribut, das href
für Querverweise ersetzt.
Im folgenden Beispiel identifizieren diese Elemente und Attribute die Markdown-Querverweise:
-
Elementname
a
und Attributxref
identifizieren „caption“. -
Elementname
a
und Attributxref
identifizieren „1“. -
Elementname
img
und Attributxref
identifizieren „img1“.
See [caption] See [Reference 1][1] My ![image][img1] ## caption [1]: https://www.acrolinx.com [img1]: /img/test.png
ref
Das Element ref
identifiziert Markdown-Referenzen. Zum Beispiel die beiden Referenzen am Ende des folgenden Markdown.
Sie können auch folgende Attribute verwenden:
-
Elementname
ref
und Attributid
identifizieren „1“ und „2“. -
Elementname
ref
und Attributvalue
identifizieren sowohl „https://www.acrolinx.com“ als auch „http://www.wikipedia.de“. -
Elementname
ref
und Attributtitle
identifizieren „German Wikipedia Site“.
Scored by [Acrolinx][1]. Visit [the Acrolinx website][1]! You may want to visit [Wikipedia][2] as well. [1]: https://www.acrolinx.com [2]: http://www.wikipedia.de "German Wikipedia Site"
imgdesc
Das Element imgdesc
identifiziert die Beschreibung eines Bildes, wie z. B. Alt-Text.
Das HTML image.alt
unterstützen wir nicht für Markdown-Content-Profile, da Beschreibungen eines Bildes eine komplexe Hierarchie aufweisen können. Stattdessen bieten wir das Element imgdesc
.
![image description](/foo/bar/foobar.png)