Freigeben über

Mitwirken mithilfe von GitHub Codespaces

GitHub verfügt über ein Feature namens Codespaces , mit dem Sie zur PowerShell-Dokumentation beitragen können, ohne software lokal installieren oder konfigurieren zu müssen. Wenn Sie einen Codespace verwenden, erhalten Sie dieselben Erstellungstools, die das Team zum Schreiben und Bearbeiten verwendet.

Sie können einen Codespace in Ihrem Browser verwenden, um in VS Code, das über das Internet gehostet wird, Änderungen vorzunehmen. Wenn Sie VS Code lokal installiert haben, können Sie auch dort eine Verbindung mit dem Codespace herstellen.

Verfügbare Tools

Wenn Sie ein Codespace für einen Beitrag zur PowerShell-Dokumentation verwenden, stehen Ihnen die folgenden Tools bereits zur Verfügung:

Kosten

GitHub-Codespaces können kostenlos bis zu 120 Kernstunden pro Monat verwendet werden. Die monatliche Nutzung wird in allen Repositorys berechnet, nicht nur dokumentationsübergreifend.

Weitere Informationen zu Preisen finden Sie unter "Abrechnung für GitHub Codespaces".

Tipp

Wenn Sie mit der Verwendung von Containern und Docker vertraut sind, können Sie die gleiche Erfahrung erzielen, indem Sie den devcontainer verwenden, der für die PowerShell-Dokumentationsrepositorys definiert ist. Es gibt keine Kosten für die Verwendung von Devcontainern. Weitere Informationen finden Sie im Lernprogramm zu Dev Containers.

Erstellen Ihres GitHub Codespace

Führen Sie die folgenden Schritte aus, um Ihren GitHub Codespace für einen Beitrag zur PowerShell-Dokumentation zu erstellen:

  1. Öffnen Sie https://github.com/codespaces in Ihrem Browser.
  2. Wählen Sie oben rechts auf der Seite die Schaltfläche "Neuer Codespace" aus.
  3. Wählen Sie auf der Seite "Neuen Codespace erstellen" die Schaltfläche "Repository auswählen" aus, und geben Sie den Namen des Repositorys ein, in das Sie beitragen möchten, z. B. MicrosoftDocs/PowerShell-Docs.
  4. Behalten Sie alle anderen Einstellungen als Standard bei.
  5. Wählen Sie die Schaltfläche "Codespace erstellen" aus.

Nachdem Sie diese Schritte ausgeführt haben, erstellt GitHub einen neuen Codespace für dieses Repository und richtet ihn für Sie ein. Wenn der Codespace bereit ist, wird die Seite aktualisiert und zeigt die Web-Editor-Benutzeroberfläche für den Codespace an. Die Benutzeroberfläche basiert auf VS Code und funktioniert auf die gleiche Weise.

Öffnen Ihres GitHub Codespaces

Führen Sie die folgenden Schritte aus, um Ihren GitHub Codespace im Browser zu öffnen:

  1. Öffnen Sie https://github.com/codespaces in Ihrem Browser.
  2. Auf dieser Seite sind die Codespaces aufgelistet. Suchen Sie den erstellten Codespace für das Repository, zu dem Sie beitragen möchten, und wählen Sie ihn aus.

Nachdem Sie Ihren Codespace ausgewählt haben, öffnet GitHub ihn im selben Fenster. Von hier aus können Sie beitragen.

Um Ihren GitHub Codespace in VS Code zu öffnen, führen Sie die Schritte unter Verwenden von GitHub Codespaces in Visual Studio Code aus.

Verfassen in Ihrem GitHub-Codespace

Sobald Ihr GitHub Codespace in Ihrem Browser oder VS Code geöffnet ist, folgt der Beitrag zur Dokumentation demselben Prozess.

Der Rest dieses Artikels beschreibt eine Auswahl von Aufgaben, die Sie in Ihrem GitHub Codespace beim Schreiben oder Bearbeiten Ihres Beitrags ausführen können.

Wenn Sie einen Inlinelink wie [some text](destination.md) in einen Verweislink umwandeln möchten, wählen Sie das Linkziel im Editor aus. Dann können Sie eine der folgenden Aktionen ausführen:

  1. Klicken Sie mit der rechten Maustaste auf das Linkziel, und wählen Sie "Umgestalten..." aus. im Kontextmenü.
  2. Drücken Sie Strg+Umschalt+R.

Beide Aktionen öffnen das Refactoring-Kontextmenü. Um das (destination.md) im Link durch [def] zu ersetzen, wählen Sie im Kontextmenü In Verknüpfungsdefinition extrahieren aus. Sie können die Definition umbenennen, indem Sie einen Namen eingeben.

Für die PowerShell-Dokumentation verwenden wir zweistellige numerische Referenzverknüpfungsdefinitionen wie [01] oder [31]. Verwenden Sie referenzverknüpfungsdefinitionen nur in Artikeln und konzeptionellen Dokumentationen. Verwenden Sie keine Referenzlinkdefinitionen in der Cmdlet-Referenzdokumentation.

Textstilverletzungen beheben

Wenn Sie einen Artikel in Ihrem Codespace überprüfen, überprüft Vale den Artikel automatisch, wenn Sie ihn zum ersten Mal öffnen und jedes Mal, wenn Sie ihn speichern. Wenn Vale Stilverletzungen feststellt, hebt es sie im Dokument mit farbigen Wellenlinien hervor.

Bewegen Sie sich über eine Verletzung, um weitere Informationen darüber anzuzeigen.

Wenn Sie eine Webseite öffnen möchten, die die Regel erläutert, wählen Sie in den Hoverinformationen den Namen der Regel aus. Um die Regel zu öffnen und die Implementierung zu überprüfen, wählen Sie den Dateinamen der Regel aus (endend in .yml).

Wenn die Regel eine Schnellkorrektur unterstützt, können Sie "Schnellkorrektur..." in den Hoverinformationen für den Verstoß auswählen und eine der vorgeschlagenen Korrekturen anwenden, indem Sie diese im Kontextmenü auswählen. Sie können auch STRG+ drücken., wenn sich der Cursor auf einem hervorgehobenen Problem befindet, um eine Schnellkorrektur anzuwenden, falls die Regel dies unterstützt.

Wenn die Regel keine Schnellkorrekturen unterstützt, lesen Sie die Nachricht der Regel, und beheben Sie sie, falls möglich. Wenn Sie nicht sicher sind, wie Sie es beheben können, können die Redakteure einen Vorschlag machen, wenn Sie Ihre PR überprüfen.

Beheben von Syntaxproblemen

Wenn Sie einen Artikel in Ihrem Codespace überprüfen, überprüft Markdownlint den Artikel automatisch, wenn Sie ihn öffnen und während der Eingabe. Wenn Markdownlint Syntaxprobleme feststellt, hebt es sie im Dokument mit farbigen Wellenlinien hervor.

Bewegen Sie sich über eine Verletzung, um weitere Informationen darüber anzuzeigen. Um eine Webseite zu öffnen, die die Regel erläutert, wählen Sie in den Hoverinformationen die ID der Regel aus.

Wenn die Regel eine Schnellkorrektur unterstützt, können Sie "Schnellkorrektur..." in den Hoverinformationen für den Verstoß auswählen und eine der vorgeschlagenen Korrekturen anwenden, indem Sie diese im Kontextmenü auswählen. Sie können auch STRG+ drücken., wenn sich der Cursor auf einem hervorgehobenen Problem befindet, um eine Schnellkorrektur anzuwenden, falls die Regel dies unterstützt.

Wenn die Regel keine Schnellkorrekturen unterstützt, lesen Sie die Nachricht der Regel, und beheben Sie sie, falls möglich. Wenn Sie nicht sicher sind, wie Sie es beheben können, können die Redakteure einen Vorschlag machen, wenn Sie Ihre PR überprüfen.

Sie können auch Korrekturen auf alle Syntaxverstöße in einem Artikel anwenden. Öffnen Sie dazu die Befehlspalette, und geben Sie folgendes ein Fix all supported markdownlint violations in the document. Während der Eingabe filtert die Befehlspalette die verfügbaren Befehle. Wählen Sie den Befehl "Alle unterstützten Markdownlintverletzungen im Dokument beheben" aus. Wenn Sie dies tun, aktualisiert Markdownlint das Dokument, um verstöße zu beheben, für die es eine schnelle Lösung gibt.

Formatieren einer Tabelle

Wenn Sie eine Markdown-Tabelle formatieren möchten, platzieren Sie den Cursor in oder auf der Tabelle in Ihrem Markdown. Öffnen Sie die Befehlspalette, und suchen Sie nach dem Table: Format Current Befehl. Wenn Sie diesen Befehl auswählen, wird der Markdown für Ihre Tabelle aktualisiert, um die Tabelle auszurichten und zu polstern, um die Lesbarkeit zu verbessern.

Es konvertiert eine wie folgt definierte Tabelle:

| foo | bar | baz |
|:--:|:--|-:|
| a | b | c |

Dazu:

|  foo  | bar  | baz  |
| :---: | :--- | ---: |
|   a   | b    |    c |

Einfügen einer Warnung

Die Dokumentation verwendet Warnungen , um Informationen für einen Leser wichtiger zu machen.

Um eine Benachrichtigung einzufügen, öffnen Sie die Befehlspalette, und suchen Sie nach dem Learn: Alert Befehl. Wenn Sie diesen Befehl auswählen, wird ein Kontextmenü geöffnet. Wählen Sie den Warnungstyp aus, den Sie hinzufügen möchten. Wenn Sie dies tun, fügt der Befehl das Markdown der Warnung am Cursor im Dokument ein.

Die Groß- und Kleinschreibung bei der Überschrift anwenden

Wenn Sie die Groß-/Kleinschreibung einer Überschrift konvertieren möchten, markieren Sie den Text der Überschrift mit Ausnahme der führenden # Symbole, welche die Überschriftenebene festlegen. Wenn der Text hervorgehoben ist, öffnen Sie die Befehlspalette, und suchen Sie nach dem Change case sentence Befehl. Wenn Sie diesen Befehl auswählen, ändert sich die Groß-/Kleinschreibung des hervorgehobenen Texts.

Sie können die Befehle zur Groß- und Kleinschreibung auch für Text im Dokument verwenden.

Öffnen der Befehlspalette

Sie können die Befehlspalette von VS Code verwenden, um viele hilfreiche Befehle auszuführen.

Um die Befehlspalette in der Benutzeroberfläche zu öffnen, wählen Sie in der oberen Menüleiste "Ansicht" aus. Wählen Sie dann im Kontextmenü "Befehlspalette..." aus.

Um die Befehlspalette mit der Tastatur zu öffnen, drücken Sie die Tastenkombination für Ihr Betriebssystem:

  • Windows und Linux: Strg+Umschalt+P
  • macOS: Cmd+Shift+P

Vorschau Ihres Beitrags

Um eine Vorschau Ihres Beitrags anzuzeigen, öffnen Sie die Befehlspalette, und suchen Sie nach dem Markdown: Open Preview Befehl. Wenn Sie diesen Befehl auswählen, öffnet VS Code eine Vorschau des aktiven Dokuments. Der Stil der Vorschau entspricht der Learn-Plattform.

Hinweis

In der Vorschau funktionieren seitenspezifische Links und Querverweise nicht.

Inhalt neu anordnen

Wenn Sie die Zeilenlängen für einen Absatz in einem Dokument einschränken möchten, platzieren Sie den Cursor auf dem Absatz. Öffnen Sie dann die Befehlspalette, und suchen Sie nach dem Reflow Markdown Befehl. Wenn Sie den Befehl auswählen, wird die Zeilenlänge des aktuellen Absatzes auf die konfigurierte Länge aktualisiert. Für unsere Repositorys beträgt diese Länge 99 Zeichen.

Wenn Sie diesen Befehl für Blockzitate verwenden, stellen Sie sicher, dass der Absatz im Blockzitat, das Sie neu umbrechen, von leeren Zeilen umgeben ist. Andernfalls fügt der Befehl alle Absätze neu zusammen.

Vorsicht

Verwenden Sie diesen Befehl beim Bearbeiten von Artikeln nicht. Die Zeilen in diesen Dokumenten dürfen nicht länger als 80 Zeichen sein. Es gibt derzeit keine Möglichkeit für ein Repository, unterschiedliche Zeilenlängen nach Ordner oder Dateinamen zu konfigurieren. Daher funktioniert der Umbruch nicht für Artikeldokumente.

Überprüfen aller Probleme in einem Dokument

Um alle Syntax- und Formatvorlagenregelverletzungen in einem Dokument zu überprüfen, öffnen Sie die Problemansicht.

Um die Problemansicht in der Benutzeroberfläche zu öffnen, wählen Sie in der oberen Menüleiste "Ansicht" aus. Wählen Sie dann im Kontextmenü "Probleme" aus.

Um die Problemansicht mit der Tastatur zu öffnen, drücken Sie die Tastenkombination für Ihr Betriebssystem:

  • Windows und Linux: Strg+Umschalt+M
  • macOS: Cmd+Shift+M

In der Problemansicht werden alle Fehler, Warnungen und Vorschläge für das geöffnete Dokument angezeigt. Wählen Sie ein Problem aus, um im Dokument zu scrollen.

Sie können die Probleme nach Typ oder Textabgleich filtern.

Aktualisieren der Ms.date-Metadaten

Um die ms.date Metadaten für einen Artikel zu aktualisieren, öffnen Sie die Befehlspalette, und suchen Sie nach dem Learn: Update "ms.date" Metadata Value Befehl. Wenn Sie den Befehl auswählen, aktualisiert er die Metadaten auf das aktuelle Datum.

Weitere Ressourcen

Die in diesem Artikel beschriebenen Aufgaben und Befehle behandeln nicht alles, was Sie mit VS Code oder den installierten Erweiterungen tun können.

Weitere Informationen zur Verwendung von VS Code finden Sie in den folgenden Artikeln:

Weitere Informationen zu den installierten Erweiterungen finden Sie in der dokumentation: