nodejs / nodejs/nodejs.org

Mermaid diagram support

Offen
#7,540 5 Kommentare 3 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

help wanted
Vorherrschende Sprache
TypeScript
Sterne
6.9k
Forks
6.5k
Ø Merge
2 T. 8 Std.
Gemergte PRs (30 T.)
29

Beschreibung

Enter your suggestions in details:

Adding support for mermaid diagrams (https://mermaid.js.org/) in blog posts could help with making diagrams. Was trying this out for the upcoming blog post for the r2 migration, but haven't been able to get it working

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die Mermaid-Dokumentation zu lesen und nachzuverfolgen, wie Blogbeiträge in nodejs.org gerendert werden, wobei der Blogbeitrag zur r2-Migration als konkretes Beispiel dient. Bestimme, wo die Diagrammunterstützung passen würde, und stelle sicher, dass ein Blogbeitrag mit einem Mermaid-Diagramm korrekt gerendert wird, bevor du das Issue als erledigt betrachtest.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
content, documentation
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Ruhig
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.