Markdown Parsing
- remark-parse:
remark-parse
ist der grundlegende Markdown-Parser im Remark-Ökosystem. Er wandelt Markdown-Text in einen syntaktischen Baum (AST) um, der von anderen Plugins zur Analyse, Manipulation oder Konvertierung des Inhalts verwendet werden kann. - remark-gfm:
remark-gfm
erweitert den Markdown-Parser, um GitHub-Flavored Markdown (GFM) zu unterstützen. Es fügt Funktionen wie Tabellen, Fußnoten und verbesserte Listen hinzu, die im GFM-Standard definiert sind, und sorgt für eine genauere Verarbeitung von GFM-kompatiblem Markdown. - remark-mdx:
remark-mdx
verarbeitet MDX-Inhalte, die eine Mischung aus Markdown und JSX sind. Es ermöglicht das Parsen von Markdown-Text zusammen mit eingebetteten React-Komponenten, was es zu einer leistungsstarken Lösung für die Erstellung interaktiver und komponentenbasierter Inhalte macht. - remark-frontmatter:
remark-frontmatter
analysiert Frontmatter-Daten aus Markdown-Dateien, die in YAML oder TOML formatiert sind. Es extrahiert diese Metadaten und macht sie im syntaktischen Baum (AST) verfügbar, sodass sie von anderen Plugins oder Anwendungen verwendet werden können. - remark-html:
remark-html
konvertiert Markdown-Inhalte in HTML. Es verarbeitet den syntaktischen Baum (AST), der von anderen Remark-Plugins erstellt wurde, und gibt eine HTML-Darstellung des Markdown-Texts zurück, die in Webanwendungen oder statischen Websites verwendet werden kann.
Frontmatter Support
- remark-parse:
remark-parse
selbst bietet keine Unterstützung für Frontmatter-Daten. Es ist ein allgemeiner Markdown-Parser, der Frontmatter nicht erkennt oder verarbeitet. Frontmatter-Daten müssen mit einem speziellen Plugin wieremark-frontmatter
analysiert werden. - remark-gfm:
remark-gfm
bietet keine spezielle Unterstützung für Frontmatter-Daten. Es konzentriert sich auf die Erweiterung der Markdown-Verarbeitung um GFM-Funktionen, behandelt jedoch Frontmatter nicht. Frontmatter-Daten müssen mit einem anderen Plugin wieremark-frontmatter
verarbeitet werden. - remark-mdx:
remark-mdx
unterstützt Frontmatter-Daten in MDX-Dateien, behandelt sie jedoch nicht speziell. Frontmatter-Daten können zusammen mit Markdown-Text und JSX-Komponenten analysiert und verwendet werden, erfordern jedoch möglicherweise ein separates Plugin zur Verarbeitung. - remark-frontmatter:
remark-frontmatter
bietet integrierte Unterstützung für Frontmatter-Daten in Markdown-Dateien. Es erkennt und analysiert Frontmatter-Abschnitte, die sich am Anfang einer Datei befinden, und extrahiert die darin enthaltenen Metadaten, die dann für weitere Verarbeitung oder Verwendung zur Verfügung stehen. - remark-html:
remark-html
bietet keine Unterstützung für Frontmatter-Daten. Es ist ein Plugin zur Konvertierung von Markdown in HTML und berücksichtigt Frontmatter-Daten nicht, es sei denn, sie werden zuvor mit einem anderen Plugin verarbeitet.
GFM Features
- remark-parse:
remark-parse
bietet keine GFM-Funktionen. Es ist ein allgemeiner Markdown-Parser, der GFM-spezifische Elemente nicht erkennt oder verarbeitet. Um GFM-Funktionen zu unterstützen, muss der Markdown-Text mit einem Plugin wieremark-gfm
verarbeitet werden. - remark-gfm:
remark-gfm
fügt GFM-Funktionen zu Markdown-Parsing hinzu, einschließlich Unterstützung für Tabellen, Fußnoten, Strichlisten und verbesserte Listen. Es sorgt dafür, dass Markdown-Inhalte, die GFM-Standards verwenden, korrekt analysiert und gerendert werden. - remark-mdx:
remark-mdx
unterstützt GFM-Funktionen, behandelt sie jedoch nicht speziell. GFM-Elemente wie Tabellen und Fußnoten können in MDX-Inhalten verwendet werden, erfordern jedoch ein separates Plugin zur Verarbeitung und Analyse von GFM-spezifischen Funktionen. - remark-frontmatter:
remark-frontmatter
bietet keine GFM-Funktionen. Es konzentriert sich auf die Verarbeitung von Frontmatter-Daten in Markdown-Dateien und hat keine Funktionen zur Unterstützung von GFM-spezifischen Elementen wie Tabellen oder Fußnoten. - remark-html:
remark-html
bietet keine GFM-Funktionen. Es konvertiert Markdown in HTML, berücksichtigt jedoch keine GFM-spezifischen Elemente. Um GFM-Funktionen zu unterstützen, muss der Markdown-Text zuerst mit einem Plugin wieremark-gfm
verarbeitet werden.
HTML Conversion
- remark-parse:
remark-parse
konvertiert keine HTML-Inhalte. Es ist ein Markdown-Parser, der den Text in einen syntaktischen Baum (AST) umwandelt, aber keine HTML-Konvertierung durchführt. Ein separates Plugin ist erforderlich, um den AST in HTML zu konvertieren. - remark-gfm:
remark-gfm
konvertiert keine HTML-Inhalte. Es erweitert den Markdown-Parser um GFM-Funktionen, die HTML-Konvertierung erfolgt jedoch nicht. Ein Plugin wieremark-html
ist erforderlich, um GFM-kompatibles Markdown in HTML zu konvertieren. - remark-mdx:
remark-mdx
konvertiert MDX-Inhalte in HTML, einschließlich der Verarbeitung von JSX-Komponenten innerhalb des Markdown-Texts. Es ermöglicht die Kombination von Markdown und React-Komponenten, was zu einer flexiblen und interaktiven HTML-Ausgabe führt. - remark-frontmatter:
remark-frontmatter
konvertiert keine HTML-Inhalte. Es analysiert Frontmatter-Daten aus Markdown-Dateien, die HTML-Konvertierung erfolgt jedoch nicht. Für die HTML-Konvertierung ist ein separates Plugin wieremark-html
erforderlich. - remark-html:
remark-html
konvertiert Markdown-Inhalte in HTML. Es verarbeitet den syntaktischen Baum (AST), der von anderen Plugins erstellt wurde, und gibt eine HTML-Darstellung des Markdown-Texts zurück, die in Webanwendungen oder statischen Websites verwendet werden kann.
Code Examples
- remark-parse:
Beispiel für die Verwendung von
remark-parse
zum Parsen von Markdown:const remark = require('remark'); const parse = require('remark-parse'); const markdown = `# Hallo Welt Dies ist ein Beispiel für Markdown.`; remark() .use(parse) .process(markdown, (err, file) => { if (err) throw err; console.log(file.contents); });
- remark-gfm:
Beispiel für die Verwendung von
remark-gfm
zur Unterstützung von GFM:const remark = require('remark'); const gfm = require('remark-gfm'); const markdown = `# Beispiel für GFM ## Tabelle | Name | Alter | |-------|-------| | Alice | 30 | | Bob | 25 | ## Fußnote Hier ist eine Fußnote[^1]. [^1]: Dies ist die Fußnote. `; remark() .use(gfm) .process(markdown, (err, file) => { if (err) throw err; console.log(String(file)); });
- remark-mdx:
Beispiel für die Verwendung von
remark-mdx
zur Verarbeitung von MDX:const remark = require('remark'); const mdx = require('remark-mdx'); const markdown = `# MDX Beispiel Hier ist ein MDX-Inhalt mit einer Komponente: <MyComponent /> `; remark() .use(mdx) .process(markdown, (err, file) => { if (err) throw err; console.log(String(file)); });
- remark-frontmatter:
Beispiel für die Verwendung von
remark-frontmatter
zum Analysieren von Frontmatter-Daten:const remark = require('remark'); const frontmatter = require('remark-frontmatter'); const markdown = `--- title: Mein Dokument layout: post --- # Hallo Welt Dies ist ein Beispiel für Frontmatter.`; remark() .use(frontmatter) .process(markdown, (err, file) => { if (err) throw err; console.log(String(file)); });
- remark-html:
Beispiel für die Verwendung von
remark-html
zur Konvertierung von Markdown in HTML:const remark = require('remark'); const html = require('remark-html'); const markdown = `# Hallo Welt Dies ist ein Beispiel für Markdown.`; remark() .use(html) .process(markdown, (err, file) => { if (err) throw err; console.log(String(file)); });