writedocs

Für Softwareteams, die eine öffentliche Anlaufstelle für Produktleitfäden und API-Referenzen benötigen, verwandelt WriteDocs ein GitHub-Dokumentationsrepository in ein gehostetes Dokumentationsportal. Verfassen Sie Seiten in Markdown oder MDX, ordnen Sie sie in Navigationselemente und Produktbereiche ein und sehen Sie sich Änderungen lokal mit der WriteDocs-CLI in der Vorschau an. Wenn Sie Aktualisierungen auf GitHub übertragen, wird das Portal automatisch bereitgestellt. Teams können das Erscheinungsbild und die Struktur eines Portals anpassen, Seitene Vorlagen und wiederverwendbare Komponenten nutzen sowie API-Referenzseiten aus OpenAPI-Dateien generieren. API-Seiten enthalten eine interaktive Testumgebung, in der Entwickler Anfragen senden und Antworten anzeigen können. WriteDocs eignet sich möglicherweise für Teams, die mit einem Dokumentationsworkflow nach dem Docs-as-Code-Prinzip vertraut sind und Produktleitfäden sowie Entwicklerdokumentation zusammen mit ihrem Code pflegen möchten.

Haftungsausschluss: WebCatalog ist nicht mit writedocs verbunden, steht nicht in Beziehung zu writedocs, ist nicht von writedocs autorisiert oder empfohlen und steht in keiner Weise in offizieller Verbindung zu writedocs. Alle Produktnamen, Logos und Marken sind Eigentum ihrer jeweiligen Inhaber.