remark-parse vs remark-gfm vs remark-mdx vs remark-frontmatter vs remark-html
"Markdown-Verarbeitung in Node.js" npm-Pakete Vergleich
3 Jahre
remark-parseremark-gfmremark-mdxremark-frontmatterremark-htmlÄhnliche Pakete:
Was ist Markdown-Verarbeitung in Node.js?

Markdown-Verarbeitungspakete in Node.js sind Bibliotheken, die Entwicklern helfen, Markdown-Inhalte zu analysieren, zu konvertieren und zu manipulieren. Diese Pakete bieten Funktionen zum Parsen von Markdown-Text, zum Konvertieren in HTML oder andere Formate und zum Bearbeiten von Markdown-Inhalten. Sie sind nützlich für Anwendungen wie Content-Management-Systeme, statische Site-Generatoren und beliebige Projekte, die mit Markdown-Text arbeiten. Diese Pakete bieten eine Vielzahl von Funktionen, darunter Unterstützung für benutzerdefinierte Markdown-Elemente, Plugins zur Erweiterung der Funktionalität und APIs zum Arbeiten mit dem strukturierten Inhalt von Markdown.

npm-Download-Trend
GitHub Stars Ranking
Statistik-Detail
Paket
Downloads
Stars
Größe
Issues
Veröffentlichung
Lizenz
remark-parse12,577,216
8,40619.5 kB1vor 2 JahrenMIT
remark-gfm6,642,908
1,00022 kB1vor 6 MonatenMIT
remark-mdx3,272,795
18,75114.7 kB16vor 10 MonatenMIT
remark-frontmatter1,555,757
29521.2 kB0vor 2 JahrenMIT
remark-html334,576
33217 kB0vor 2 JahrenMIT
Funktionsvergleich: remark-parse vs remark-gfm vs remark-mdx vs remark-frontmatter vs remark-html

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 wie remark-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 wie remark-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 wie remark-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 wie remark-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 wie remark-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 wie remark-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));
      });
    
Wie man wählt: remark-parse vs remark-gfm vs remark-mdx vs remark-frontmatter vs remark-html
  • remark-parse:

    Wählen Sie remark-parse, wenn Sie einen Markdown-Parser benötigen, der Markdown-Text in einen syntaktischen Baum (Abstract Syntax Tree, AST) umwandelt. Es ist das grundlegende Plugin für das Parsen von Markdown in der Remark-Ökosystem.

  • remark-gfm:

    Wählen Sie remark-gfm, wenn Sie die Unterstützung für GitHub-Flavored Markdown (GFM) benötigen, einschließlich Funktionen wie Tabellen, Fußnoten und Strichlisten. Es ist ideal für Projekte, die eine erweiterte Markdown-Unterstützung mit GFM-Features erfordern.

  • remark-mdx:

    Wählen Sie remark-mdx, wenn Sie MDX (Markdown + JSX) verarbeiten müssen, das die Verwendung von React-Komponenten innerhalb von Markdown ermöglicht. Es ist ideal für Projekte, die interaktive oder komponentenbasierte Inhalte in ihren Markdown-Dateien benötigen.

  • remark-frontmatter:

    Wählen Sie remark-frontmatter, wenn Sie Frontmatter-Daten (YAML oder TOML) aus Markdown-Dateien extrahieren oder analysieren müssen. Es ist besonders nützlich für statische Site-Generatoren und Content-Management-Systeme, die Metadaten aus Markdown-Inhalten benötigen.

  • remark-html:

    Wählen Sie remark-html, wenn Sie Markdown-Inhalte in HTML konvertieren müssen. Es ist ein einfaches und effektives Plugin für die HTML-Ausgabe von Markdown, das in Kombination mit anderen Remark-Plugins verwendet werden kann.