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

Dieser Beitrag wurde von Adam Kinney, Senior Software Engineer im docs.microsoft.com Team geschrieben.

Heute freuen wir uns, die Veröffentlichung des Docs Authoring Pack für Visual Studio Codebekannt zu geben, wodurch es einfacher denn je ist, zu docs.microsoft.com beizutragen. Diese erste Version des Pakets enthält drei Erweiterungen:

• Docs Markdown- – bietet Unterstützung bei der Markdown-Erstellung, einschließlich Formatierung von Text, Einfügen von Listen und Tabellen, Einfügen von Links zu anderen Inhalten und Hinzufügen von Bildern und anderen Ressourcen. Im Gegensatz zu anderen Markdown-Editoren unterstützt Docs Markdown benutzerdefinierte Markdown-Erweiterungen für docs.microsoft.com, z. B. Warnungen und Codeausschnitte.
• DocFX- – bietet eine eingeschränkte docs.microsoft.com-spezifische Markdown-Vorschau, um zu sehen, wie Ihre Markdown-Datei aussieht, wenn sie veröffentlicht wird.
• markdownlint - ein beliebter Markdown linter von David Anson, um sicherzustellen, dass Ihr Markdown bewährte Methoden befolgt.

Funktionsweise

Zuerst müssen Sie es aus dem Visual Studio Marketplace installieren. Sobald Sie zur Erweiterungsseitenavigieren, klicken Sie einfach auf Installieren und folgen Sie den Nachrichten auf dem Bildschirm:

Sobald Sie fertig sind, sollten Sie Visual Studio Code neu laden, eine Markdown-Datei öffnen und mit dem Schreiben beginnen! Verwenden Sie die Tastenkombination Alt+M, um auf die Befehlspalette der Docs Markdown-Erweiterung zuzugreifen, sodass Sie den Text schnell formatieren können (z. B. fett oder kursiv formatieren), Standard-Markdown-Entitäten wie eine nummerierte Liste oder eine Tabelle einfügen sowie dokumentspezifisches Markup für Notizen, wichtige Informationen und Tipps einfügen:

Sie können code auch schnell aus anderen Dateien über eine DocFX-kompatible Markdown-Erweiterungeinfügen und eine Vorschau der Seite anzeigen, an der Sie direkt im Editor arbeiten:

Beitragen

Die Erweiterung ist Open Source, und wir begrüßen alle Beiträge zu ihr!

Die meisten Beiträge erfordern, dass Sie einem Mitwirkenden-Lizenzvertrag (CLA) zustimmen müssen, der bestätigt, dass Sie das Recht haben, uns tatsächlich die Rechte zur Nutzung Ihres Beitrags zu gewähren. Weitere Informationen finden Sie unter https://cla.microsoft.com.

Wenn Sie eine Pullanfrage einreichen, bestimmt ein CLA-Bot automatisch, ob Sie eine CLA bereitstellen und die PR entsprechend dekorieren müssen (z. B. Bezeichnung, Kommentar). Folgen Sie einfach den Anweisungen des Bots. Sie müssen dies nur einmal in allen microsoft-eigenen Repositorys mit unserem CLA tun.

Feedback senden

Haben Sie Gedanken darüber, wie wir die Erweiterung verbessern können? einfach ein neues Problemöffnen!

Und vergessen Sie nicht, unserem Twitter-Konto für die neuesten Updates zu folgen.

Träumen Sie davon, die Welt für Entwickler besser zu machen? Treten Sie unserem Teambei!