Bijdragen met Behulp van GitHub Codespaces

GitHub heeft een functie met de naam Codespaces die u kunt gebruiken om bij te dragen aan de PowerShell-documentatie zonder dat u software lokaal hoeft te installeren of te configureren. Wanneer u een codespace gebruikt, krijgt u dezelfde ontwerphulpprogramma's die het team gebruikt voor het schrijven en bewerken.

U kunt een coderuimte in uw browser gebruiken, waardoor uw bijdragen in VS Code via internet worden gehost. Als VS Code lokaal is geïnstalleerd, kunt u daar ook verbinding maken met de coderuimte.

Beschikbare hulpmiddelen

Wanneer u een codespace gebruikt om bij te dragen aan de PowerShell-documentatie, zijn deze hulpprogramma's al beschikbaar voor u:

Kosten

GitHub Codespaces kan gratis worden gebruikt voor maximaal 120 kernuren per maand. Het maandelijkse gebruik wordt berekend in al uw opslagplaatsen, niet alleen documentatie.

Zie Facturering voor GitHub Codespaces voor meer informatie over prijzen.

Hint

Als u vertrouwd bent met het gebruik van containers en Docker, kunt u dezelfde ervaring krijgen met behulp van de devcontainer die is gedefinieerd voor de PowerShell-documentatieopslagplaatsen. Er zijn geen kosten verbonden aan het gebruik van devcontainers. Zie de zelfstudie Dev Containers voor meer informatie.

Uw GitHub Codespace maken

Volg deze stappen om uw GitHub Codespace te maken voor bijdragen aan PowerShell-documentatie:

  1. Open https://github.com/codespaces in uw browser.
  2. Selecteer de knop Nieuwe coderuimte in de rechterbovenhoek van de pagina.
  3. Selecteer op de pagina Een nieuwe coderuimte maken de knop Een opslagplaats selecteren en typ de naam van de opslagplaats waaraan u een bijdrage wilt leveren, bijvoorbeeld MicrosoftDocs/PowerShell-Docs.
  4. Laat alle andere instellingen op de standaardwaarde staan.
  5. Selecteer de knop "Codespace maken".

Nadat u deze stappen hebt uitgevoerd, maakt GitHub een nieuwe coderuimte voor die opslagplaats en stelt deze voor u in. Wanneer de codespace gereed is, wordt de pagina vernieuwd en wordt de gebruikersinterface van de webeditor voor de coderuimte weergegeven. De gebruikersinterface is gebaseerd op VS Code en werkt op dezelfde manier.

Uw GitHub Codespace openen

Voer de volgende stappen uit om uw GitHub Codespace in de browser te openen:

  1. Open https://github.com/codespaces in uw browser.
  2. De pagina somt uw Codespaces op. Zoek de gemaakte coderuimte voor de opslagplaats waaraan u wilt bijdragen en selecteer deze.

Nadat u uw codespace hebt geselecteerd, wordt deze in GitHub in hetzelfde venster geopend. Van hieruit bent u klaar om een bijdrage te leveren.

Als u uw GitHub Codespace in VS Code wilt openen, volgt u de stappen in GitHub Codespaces gebruiken in Visual Studio Code.

Schrijven in uw GitHub Codespace

Zodra uw GitHub Codespace is geopend in uw browser of VS Code, volgt het bijdragen aan de documentatie hetzelfde proces.

In de rest van dit artikel wordt een selectie van taken beschreven die u in uw GitHub Codespace kunt uitvoeren tijdens het schrijven of bewerken van uw bijdrage.

Als u een inlinekoppeling [some text](destination.md)wilt omzetten in een verwijzingskoppeling zoals [some text][01], selecteert u het koppelingsdoel in de editor. Vervolgens kunt u het volgende doen:

  1. Klik met de rechtermuisknop op het koppelingsdoel en selecteer 'Herstructureren...' in het snelmenu.
  2. Druk op Ctrl+Shift+R.

Met beide acties wordt het contextmenu voor herstructureren geopend. Als u (destination.md) in de link wilt vervangen door [def], selecteert u Extract to link definition in het contextmenu. U kunt de naam van de definitie wijzigen door een naam in te voeren.

Voor de PowerShell-documentatie gebruiken we definities van numerieke verwijzingskoppelingen met twee cijfers, zoals [01] of [31]. Gebruik alleen referentiekoppelingsdefinities in artikelen en conceptuele documentatie. Gebruik geen referentiekoppelingsdefinities in de referentiedocumentatie voor cmdlets.

Overtredingen van de prozastijl oplossen

Wanneer u een artikel in uw codespace bekijkt, controleert Vale het artikel automatisch wanneer u het voor het eerst opent en telkens wanneer u het opslaat. Als Vale schendingen van stijl vindt, worden deze gemarkeerd in het document met gekleurde kronkelen.

Beweeg de muisaanwijzer over een schending om er meer informatie over te zien.

Als u een webpagina wilt openen waarin de regel wordt uitgelegd, selecteert u de naam van de regel in de hoverinformatie. Als u de regel wilt openen en de implementatie wilt controleren, selecteert u de bestandsnaam van de regel (eindigend op .yml).

Als de regel een snelle oplossing ondersteunt, kunt u 'Snelle oplossing...' selecteren in de aanwijsinformatie voor de schending en pas een van de voorgestelde oplossingen toe door deze te selecteren in het contextmenu. U kunt ook op Ctrl+ drukken. Wanneer de cursor zich op een gemarkeerd probleem bevindt om een snelle oplossing toe te passen als de regel dit ondersteunt.

Als de regel geen snelle oplossingen ondersteunt, leest u het bericht van de regel en lost u dit zo mogelijk op. Als u niet zeker weet hoe u dit kunt oplossen, kunnen de redacteuren een suggestie doen bij het controleren van uw pull request.

Syntaxisproblemen oplossen

Wanneer u een artikel in uw codespace bekijkt, controleert Markdownlint het artikel automatisch wanneer u het opent en terwijl u typt. Als Markdownlint syntaxisproblemen vindt, markeert het deze in het document met gekleurde golfjes.

Beweeg de muisaanwijzer over een schending om er meer informatie over te zien. Als u een webpagina wilt openen waarin de regel wordt uitgelegd, selecteer dan de ID van de regel in de zweefinformatie.

Als de regel een snelle oplossing ondersteunt, kunt u 'Snelle oplossing...' selecteren in de aanwijsinformatie voor de schending en pas een van de voorgestelde oplossingen toe door deze te selecteren in het contextmenu. U kunt ook op Ctrl+ drukken. Wanneer de cursor zich op een gemarkeerd probleem bevindt om een snelle oplossing toe te passen als de regel dit ondersteunt.

Als de regel geen snelle oplossingen ondersteunt, leest u het bericht van de regel en lost u dit zo mogelijk op. Als u niet zeker weet hoe u dit kunt oplossen, kunnen de redacteuren een suggestie doen bij het controleren van uw pull request.

U kunt ook correcties toepassen op alle syntaxisschendingen in een artikel. Hiervoor opent u het opdrachtpalet en typt u Fix all supported markdownlint violations in the document. Terwijl u typt, filtert het opdrachtenpalet de beschikbare opdrachten. Selecteer de opdracht Alle ondersteunde markdownlint-schendingen in het document herstellen. Wanneer u dit doet, werkt Markdownlint het document bij om eventuele schendingen op te lossen waarvoor het een snelle oplossing heeft.

Een tabel opmaken

Als u een Markdown-tabel wilt opmaken, plaatst u de cursor in of in de tabel in uw Markdown. Open het opdrachtenpalet en zoek de Table: Format Current opdracht. Wanneer u deze opdracht selecteert, wordt de Markdown voor uw tabel bijgewerkt om de tabel uit te lijnen en op te vullen voor een betere leesbaarheid.

Er wordt een tabel geconverteerd die als volgt is gedefinieerd:

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

Hiervoor:

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

Een waarschuwing invoegen

In de documentatie worden waarschuwingen gebruikt om informatie beter leesbaar te maken voor een lezer.

Als u een waarschuwing wilt invoegen, kunt u het opdrachtenpalet openen en naar de Learn: Alert opdracht zoeken. Wanneer u die opdracht selecteert, wordt er een contextmenu geopend. Selecteer het waarschuwingstype dat u wilt toevoegen. Als u dat doet, voegt de opdracht de Markdown van de waarschuwing op de locatie van de cursor in het document in.

Maak een kop in zinsopmaak

Om de kapitalisatie van een koptekst te converteren, markeer je de tekst van de kop, met uitzondering van de voorloopsymbolen #, die het kopniveau instellen. Wanneer u de tekst hebt gemarkeerd, opent u het opdrachtenpalet en zoekt u de Change case sentence opdracht. Wanneer u deze opdracht selecteert, wordt de behuizing van de gemarkeerde tekst geconverteerd.

U kunt ook de hoofdlettergebruikcommando's gebruiken voor tekst in het document.

Het opdrachtpalet openen

U kunt het opdrachtenpalet van VS Code gebruiken om veel nuttige opdrachten uit te voeren.

Als u het opdrachtenpalet in de gebruikersinterface wilt openen, selecteert u 'Beeld' in de bovenste menubalk. Selecteer vervolgens 'Opdrachtpalet...' in het snelmenu.

Als u het opdrachtenpalet met het toetsenbord wilt openen, drukt u op de toetsencombinatie voor uw besturingssysteem:

  • Windows en Linux: Ctrl+Shift+P
  • macOS: Cmd+Shift+P

Een voorbeeld van uw bijdrage bekijken

Als u een voorbeeld van uw bijdrage wilt bekijken, opent u het opdrachtpalet en zoekt u de Markdown: Open Preview opdracht. Wanneer u die opdracht selecteert, opent VS Code een voorbeeld van het actieve document. De stijl van de preview komt overeen met het Learn-platform.

Opmerking

Site-relatieve koppelingen en kruisverwijzingen werken niet in de voorvertoning.

Uw inhoud herschikken

Als u de regellengten voor een alinea in een document wilt beperken, plaatst u de cursor op de alinea. Open vervolgens het opdrachtenpalet en zoek de Reflow Markdown opdracht. Wanneer u de opdracht selecteert, worden de regellengten van de huidige alinea bijgewerkt naar de geconfigureerde lengte. Voor onze opslagplaatsen is die lengte 99 tekens.

Wanneer u deze opdracht gebruikt voor blokcitaten, moet u ervoor zorgen dat de alinea in de blokcitaat die u wilt aanpassen, wordt omgeven door lege regels. Anders herschikt de opdracht elke alinea.

Waarschuwing

Gebruik deze opdracht niet bij het bewerken van artikelen. De regels in deze documenten mogen niet langer zijn dan 80 tekens. Er is momenteel geen manier voor een opslagplaats om verschillende regellengten per map of bestandsnaam te configureren, dus werkt herstroom niet voor artikeldocumenten.

Alle problemen in een document bekijken

Als u alle schendingen van syntaxis- en stijlregels in een document wilt bekijken, opent u de weergave Problemen.

Als u de weergave Problemen in de gebruikersinterface wilt openen, selecteert u 'Weergave' in de bovenste menubalk. Selecteer vervolgens 'Problemen' in het snelmenu.

Als u de weergave Problemen met het toetsenbord wilt openen, drukt u op de toetsencombinatie voor uw besturingssysteem:

  • Windows en Linux: Ctrl+Shift+M
  • macOS: Cmd+Shift+M

In de weergave Problemen worden alle fouten, waarschuwingen en suggesties voor het geopende document weergegeven. Selecteer een probleem om ernaar te schuiven in het document.

U kunt de problemen filteren op type of tekstovereenkomst.

De metagegevens ms.date bijwerken

Als u de ms.date metagegevens voor een artikel wilt bijwerken, opent u het opdrachtenpalet en zoekt u de Learn: Update "ms.date" Metadata Value opdracht. Wanneer u de opdracht selecteert, worden de metagegevens bijgewerkt naar de huidige datum.

Aanvullende bronnen

De taken en opdrachten die in dit artikel worden beschreven, hebben niet betrekking op alles wat u kunt doen met VS Code of de geïnstalleerde extensies.

Zie de volgende artikelen voor meer informatie over het gebruik van VS Code:

Zie de documentatie voor meer informatie over de geïnstalleerde extensies:

  • Last updated on