Ankündigung der Docs Markdown-Erweiterung für Visual Studio Code

Dieser Beitrag wurde von Adam Kinney verfasst. Er ist Senior Software Engineer im Team von docs.microsoft.com.

Wir freuen uns, heute die Veröffentlichung des Docs Authoring Pack-Releases für Visual Studio Code bekanntgeben zu können, durch das Beiträge zu docs.microsoft.com noch einfacher werden. Dieses erste Release des Pakets beinhaltet drei Erweiterungen:

  • Docs Markdown unterstützt die Erstellung von Inhalten mit Markdown. Diese Unterstützung umfasst das Formatieren von Text, das Einfügen von Listen und Tabellen, das Einfügen von Links zu anderen Inhalten und das Hinzufügen von Bildern und anderen Objekten. Im Gegensatz zu anderen Markdown-Editoren unterstützt Docs Markdown benutzerdefinierte Markdown-Erweiterungen für docs.microsoft.com, z.B. Warnungen und Codeausschnitte.
  • DocFX unterstützt speziell für docs.microsoft.com eine eingeschränkte Markdown-Vorschau, mit der Sie sich ansehen können, wie eine Markdown-Datei nach der Veröffentlichung aussehen wird.
  • markdownlint ist ein häufig eingesetzter Markdown-Linter von David Anson, mit dem Sie sicherstellen können, dass Ihr Markdown-Code den Best Practices entspricht.

Funktionsweise

Zunächst müssen Sie die Erweiterung über den Visual Studio Marketplace installieren. Rufen Sie dazu die Erweiterungsseite auf, klicken Sie auf Install (Installieren), und folgen Sie den Anweisungen auf dem Bildschirm:

Installation of the Docs Markdown Extension

Nach der Installation sollten Sie Visual Studio Code erneut laden. Nun können Sie eine Markdown-Datei öffnen und mit der Erstellung von Inhalten beginnen. Mit der Tastenkombination Alt+M rufen Sie die Befehlspalette der Docs Markdown-Erweiterung auf. Mit dieser Befehlspalette können Sie Text unkompliziert formatieren (z.B. durch eine fette oder kursive Hervorhebung), Markdown-Standardentitäten wie eine nummerierte Liste oder eine Tabelle einfügen und dokumentationsspezifische Markups für Hinweise, wichtige Informationen und Tipps erstellen:

Extension command palette

Mit einer DocFX-kompatiblen Markdown-Erweiterung haben Sie außerdem die Möglichkeit, Code aus anderen Dateien in wenigen Augenblicken einzufügen und sich eine Vorschau der Seite anzeigen zu lassen, an der Sie direkt im Editor arbeiten:

Preview the currently edited page

Mitwirken

Da es sich um eine Open Source-Erweiterung handelt, freuen wir uns immer über neue Beiträge.

Für die meisten Beiträge müssen Sie einer Lizenzvereinbarung für Mitwirkende (CLA) zustimmen. Hierdurch versichern Sie, dass Sie dazu berechtigt sind, die Rechte an der Verwendung Ihrer Beiträge an uns zu übertragen, und von diesem Übertragungsrecht auch Gebrauch machen. 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 unter Verwendung unserer CLA für sämtliche Microsoft-Repositorys nur einmal erforderlich.

Feedback

Sie haben Vorschläge zur Verbesserung der Erweiterung? 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!