[mkdocs] - explore how to move away from multiple .html files to just one .md file per page
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- JavaScript
- Sterne
- 18.3k
- Forks
- 2k
- Ø Merge
- 2 T. 12 Std.
- Gemergte PRs (30 T.)
- 28
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
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.
Bewertung
- Tech-Stack
- markdown
- Bereich
- documentation
- Issue-Typ
- Refactoring
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 30/100