egoist/babel-plugin-markdown

Identify markdown by comments

Open

#4 geöffnet am 7. Juli 2017

Auf GitHub ansehen
 (0 Kommentare) (1 Reaktion) (0 zugewiesene Personen)JavaScript (2 Forks)user submission
enhancementhelp wanted

Repository-Metriken

Stars
 (14 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

const html = `<!-- markdown -->
# hello
`

In this way eslint won't warn you about the undefined variable: markdown.

Contributor Guide

Research-Richtung
Untersuche zunächst den Quellcode des Plugins (wahrscheinlich index.js), um zu verstehen, wie er derzeit Markdown in JavaScript Dateien erkennt und transformiert. Implementiere dann eine Prüfung für HTML Kommentare, die ' markdown ' enthalten (z. B. `<! markdown >`), und behandle den Inhalt darin als Markdown. Überprüfe vorhandene Tests im Repository, um sicherzustellen, dass keine Regressionen auftreten. Überlege, ob die Kommentarerfassung konfigurierbar sein sollte. Die Änderung ist lokalisiert, erfordert jedoch Vertrautheit mit der AST Manipulation von Babel.
Tech Stack
javascriptnodejs
Domain
build system
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Recherche nötig
Voraussetzungen
JavaScriptBabel
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
50