Eine neue Version des Pakets zur Dokumenterstellung für Visual Studio Code

Dieser Beitrag wurde von Megan Bradley verfasst, Senior Program Manager im docs.microsoft.com-Team.

Im April haben wir das erste Release des Docs Authoring Pack (Paket zur Dokumentationserstellung) für VS Code angekündigt, dass die Docs Markdown-Erweiterung enthält. Dies ist eine Erweiterung, mit der eine Vorschau von Bearbeitungen basierend auf DocFX sowie markdownlint angezeigt werden kann. Wir freuen uns, heute das zweite wichtige Release des Docs Authoring Pack ankündigen zu können, das die folgenden neuen Erweiterungen enthält:

  • Code Spell Checker (Rechtschreibprüfung für Code): Aufgrund der großen Nachfrage haben wir diese Offline-Rechtschreibprüfung von Street Side Software mit eingeschlossen, damit Mitwirkende ihre gesamten Inhalte auf Rechtschreibfehler überprüfen können (einschließlich von Codebeispielen), ohne dies über einen Onlinedienst tun zu müssen.
  • Docs Article Templates (Artikelvorlagen für die Dokumentation): Mit dieser Erweiterung können Sie eine Markdownvorlage auf eine neue Datei anwenden, wodurch es einfacher wird, Inhalte und Metadaten konsistent zu erstellen.
  • Docs Preview (Dokumentationsvorschau): Dies ist ein Ersatz für die DocFx-Vorschau, die im ersten Release des Docs Authoring Pack enthalten war. Die neue Vorschauerweiterung ist wesentlich robuster und stellt das CSS von docs.microsoft.com mit höherer Genauigkeit dar.

Sie können die Erweiterungen einzeln über die oben genannten Links oder in einem einzelnen Paket über das Docs Authoring Pack installieren.

Einführung in Artikelvorlagen

Bei den Artikelvorlagen handelt es sich um Markdown-Skeletondateien, die Standardüberschriften, Dateimetadaten, Textbausteine und andere Grundelemente enthalten, die den Richtlinien von docs.microsoft.com entsprechen. Dadurch wird das Verfassen neuer Artikel sowie das Verständnis von Veröffentlichungsanforderungen einfacher.

Um eine neue Datei basierend auf einer vorhandenen Vorlage zu erstellen, drücken Sie einfach ALT+M, und wählen Sie Vorlage aus:

apply template

Bessere Vorschau

Die frühere DocFX-basierte Vorschau-Engine wurde durch die neue Docs Preview ersetzt, die die folgenden Verbesserungen bietet:

  • Unterstützung für den CommonMark-kompatiblen Markdig-Parser anstelle der DocFx-basierten Markdownsprache (DFM)
  • Aktuelles CSS von docs.microsoft.com, durch welches benutzerdefinierte Markdownelemente mit höherer Genauigkeit gerendert werden
  • Verbesserte Zuverlässigkeit, wodurch Vorschauen schneller und ohne Verzögerungen gerendert werden
  • Sofortige Unterstützung für die ständig anwachsende Liste der Docs-spezifischen Markdownerweiterungen

Mitwirken

Die Docs Markdown-Erweiterungen sind Open-Source – Wir freuen uns über Beitrage!

Beachten Sie, dass Sie bei den meisten Beiträgen einer Lizenzvereinbarung für Mitwirkende (CLA) zustimmen müssen, in der Sie bestätigen, dass Sie das Recht haben, uns die Rechte zur Verwendung Ihres Beitrags in unserer Software und unseren Inhalten einzuräumen, und dass Sie uns diese Rechte auch tatsächlich gewähren. Ausführliche Informationen finden Sie unter https://cla.microsoft.com. Wenn Sie einen Pull Request (PR) übermitteln, überprüft ein CLA-Bot automatisch, ob Sie eine Lizenzvereinbarung bereitstellen und den PR entsprechend ergänzen müssen (z.B. mit einer Bezeichnung oder einem Kommentar). Führen Sie einfach die Anweisungen des Bots aus. Dieser Vorgang ist für sämtliche Microsoft-Repositorys nur einmal erforderlich.

Feedback

Sie haben Vorschläge zur Verbesserung der Erweiterungen? Dann erstellen Sie einfach ein neues Thema.

Wenn Sie Interesse an den neuesten Entwicklungen haben, können Sie uns auf Twitter folgen.

Sie möchten Entwicklern ihre Arbeit erleichtern? Werden Sie Teil unseres Teams!