[mkdocs] - explore how to move away from multiple .html files to just one .md file per page

Offen
#7,645 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
30/100
Issue-Typ
Refactoring
Klarheit
Muss geklärt werden
Aktivitätsstatus
Veraltet
Tech-Stack
markdown
Bereich
documentation

Rechercherichtung

Beginnen Sie damit zu prüfen, wie die bestehende Dokumentation für jede Seite auf mehrere .html-Dateien aufgeteilt ist und wie diese Dateien erstellt werden. Legen Sie einen Migrationsansatz fest, sodass jede Seite in einer .md-Datei bearbeitet werden kann, während der vorhandene Dokumentationsinhalt und die Ausgabe erhalten bleiben.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

We should move away from having .html files as the files that you edit to make changes to the docs. Ideally to edit the docs you'd edit a .md file and everything for a specific page is in the one .md file.

Having multiple html files for one page like we have in our existing docs, makes it challenging to create new content and edit existing content.

Vorherrschende Sprache
JavaScript
Sterne
18.3k
Forks
2k
Ø Merge
2 T. 12 Std.
Gemergte PRs (30 T.)
28

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus plotly/plotly.js

Alle Issues in plotly/plotly.js

Ähnliche Issues

Weitere Issues zu JavaScript

Neue Issues direkt in Ihr Postfach

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