markdown export
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 35/100
- Issue-Typ
- Feature
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- markdown
- Bereich
- documentation
Rechercherichtung
Das Issue benennt keine Dateien, Tests oder Code-Einstiegspunkte. Beginne damit nachzuverfolgen, wie vorhandene Dokumentationsseiten über ihre HTML-URLs ausgeliefert werden, und ermittle anschließend, wie eine .md-URL, sofern verfügbar, das ursprüngliche Markdown offenlegen könnte. Der Abschluss sollte ein definiertes Verhalten für den Markdown-Export der vorhandenen Dokumentation sowie eine Abdeckung der relevanten Seitentypen umfassen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
Couldn't sort out how to add something to Trello, adding here.
Feature request
Markdown export to existing docs (where possible).
Summary
The idea would be to show a markdown version of a page by using the ".md" extension to url's. This would be an alternative to the HTML view.
Devdocs already has simplified views of documentation, adding an option to view documentation or export documentation in markdown view would add some additional utility. Rather than depending on a conversion from html to markdown, especially in case where a document was originally in markdown.
This would also enable a potential AI integration, where markdown is preferred.
Examples
I came across another service having the feature: https://www.mintlify.com/docs/ai/markdown-export
- Vorherrschende Sprache
- Ruby
- Sterne
- 39.5k
- Forks
- 2.6k
- Ø Merge
- 2 T. 9 Std.
- Gemergte PRs (30 T.)
- 13
Beitragsleitfaden
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus freeCodeCamp/devdocs
-
class Data in Ruby 3.2 Offendocs/improvement
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100
freeCodeCamp/devdocs#1989 · 4 Kommentare · 4 Reaktionen ·
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 20/100
freeCodeCamp/devdocs#2731 ·
-
feature
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100
freeCodeCamp/devdocs#2712 ·
-
feature
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 30/100
freeCodeCamp/devdocs#2683 · 1 Kommentar ·
-
Unit test frontend code Offenfeature
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 45/100
freeCodeCamp/devdocs#2673 ·
Alle Issues in freeCodeCamp/devdocs
Ähnliche Issues
-
bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
hanami/hanami-cli#449 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
resque/resque-scheduler#826 ·
-
bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100