Bidra med GitHub Codespaces

GitHub har en funktion som heter Codespaces som du kan använda för att bidra till PowerShell-dokumentationen utan att behöva installera eller konfigurera någon programvara lokalt. När du använder ett kodområde får du samma redigeringsverktyg som teamet använder för att skriva och redigera.

Du kan använda ett kodområde i webbläsaren och göra dina bidrag i VS Code via Internet. Om du har VS Code installerat lokalt kan du ansluta till kodområdet där också.

Tillgängliga verktyg

När du använder ett kodområde för att bidra till PowerShell-dokumentationen har redigeraren redan dessa verktyg tillgängliga för dig:

Kostnad

GitHub Codespaces kan användas kostnadsfritt upp till 120 kärntimmar per månad. Den månatliga användningen beräknas för alla dina lagringsplatser, inte bara i dokumentationen.

Mer information om priser finns i Om fakturering för GitHub Codespaces.

Tips/Råd

Om du är bekväm med att använda containrar och Docker kan du få samma upplevelse med hjälp av devcontainer som definierats för PowerShell-dokumentationslagringsplatserna. Det kostar ingenting att använda devcontainers. Mer information finns i självstudiekursen om Dev Containers.

Skapa ditt GitHub Codespace

Följ dessa steg om du vill skapa ditt GitHub Codespace för att bidra till PowerShell-dokumentationen:

  1. Öppna https://github.com/codespaces i webbläsaren.
  2. Välj knappen "Nytt kodområde" längst upp till höger på sidan.
  3. På sidan "Skapa ett nytt kodområde" väljer du knappen "Välj en lagringsplats" och skriver namnet på den lagringsplats som du vill bidra till, till exempel MicrosoftDocs/PowerShell-Docs.
  4. Lämna alla andra inställningar som standard.
  5. Välj knappen "Skapa kodområde".

När du har följt de här stegen skapar GitHub ett nytt kodområde för lagringsplatsen och konfigurerar det åt dig. När kodområdet är klart uppdateras sidan och visar webbredigerarens användargränssnitt för kodområdet. Användargränssnittet baseras på VS Code och fungerar på samma sätt.

Öppna Ditt GitHub Codespace

Följ dessa steg för att öppna GitHub Codespace i webbläsaren:

  1. Öppna https://github.com/codespaces i webbläsaren.
  2. Sidan visar dina Codespaces. Leta upp det skapade kodområdet för den lagringsplats som du vill bidra till och välj det.

När du har valt ditt kodområde öppnar GitHub det i samma fönster. Härifrån är du redo att bidra.

Om du vill öppna GitHub Codespace i VS Code följer du stegen i Använda GitHub Codespaces i Visual Studio Code.

Skapande i GitHub Codespace

När du har öppnat GitHub Codespace i webbläsaren eller VS Code följer bidrag till dokumentationen samma process.

Resten av den här artikeln beskriver ett urval av uppgifter som du kan utföra i GitHub Codespace när du skriver eller redigerar ditt bidrag.

När du vill omvandla en infogad länk, till exempel [some text](destination.md), till en referenslänk som [some text][01], väljer du länkmålet i redigeraren. Sedan kan du antingen:

  1. Högerklicka på länkmålet och välj "Omstrukturera..." i snabbmenyn.
  2. Tryck på Ctrl+Skift+R.

Båda åtgärderna genererar snabbmenyn för refaktorisering. Om du vill ersätta (destination.md) i länken med [def]väljer du Extrahera för att länka definitionen i snabbmenyn. Du kan byta namn på definitionen genom att skriva in ett namn.

I PowerShell-dokumentationen använder vi numeriska referenslänkdefinitioner med två siffror, t.ex [01] . eller [31]. Använd endast referenslänkdefinitioner i om artiklar och konceptuell dokumentation. Använd inte referenslänkdefinitioner i cmdlet-referensdokumentationen.

Åtgärda överträdelser av prosastil

När du granskar en artikel i kodområdet kontrollerar Vale automatiskt artikeln när du öppnar den och varje gång du sparar den. Om Vale hittar några stilfel markeras de i dokumentet med färgade vågiga understrykningar.

Hovra över en överträdelse om du vill se mer information om den.

Om du vill öppna en webbsida som förklarar regeln väljer du regelns namn i hovringsinformationen. Om du vill öppna regeln och granska dess implementering väljer du regelns filnamn (slutar i .yml).

Om regeln stöder en snabbkorrigering kan du välja "Snabbkorrigering..." i hovringsinformationen för överträdelsen och tillämpa en av de föreslagna korrigeringarna genom att välja den på snabbmenyn. Du kan också trycka på Ctrl+. När markören har ett markerat problem kan du använda en snabbkorrigering om regeln stöder det.

Om regeln inte stöder snabbkorrigeringar läser du regelns meddelande och åtgärdar det om du kan. Om du inte är säker på hur du åtgärdar det kan redigerarna komma med ett förslag när de granskar din PR.

Åtgärda syntaxproblem

När du granskar en artikel i kodområdet kontrollerar Markdownlint automatiskt artikeln när du öppnar den och när du skriver. Om Markdownlint hittar några syntaxproblem markerar den dem i dokumentet med färgade krumelurer.

Hovra över en överträdelse om du vill se mer information om den. Om du vill öppna en webbsida som förklarar regeln väljer du regelns ID i hovringsinformationen.

Om regeln stöder en snabbkorrigering kan du välja "Snabbkorrigering..." i hovringsinformationen för överträdelsen och tillämpa en av de föreslagna korrigeringarna genom att välja den på snabbmenyn. Du kan också trycka på Ctrl+. När markören har ett markerat problem kan du använda en snabbkorrigering om regeln stöder det.

Om regeln inte stöder snabbkorrigeringar läser du regelns meddelande och åtgärdar det om du kan. Om du inte är säker på hur du åtgärdar det kan redigerarna komma med ett förslag när de granskar din PR.

Du kan också tillämpa korrigeringar på alla syntaxöverträdelser i en artikel. Om du vill göra det öppnar du kommandopaletten och skriver Fix all supported markdownlint violations in the document. När du skriver filtrerar kommandopaletten de tillgängliga kommandona. Välj kommandot "Åtgärda alla markdownlintöverträdelser som stöds i dokumentet". När du gör det uppdaterar Markdownlint dokumentet för att lösa eventuella överträdelser som det har en snabbkorrigering för.

Formatera en tabell

Om du vill formatera en Markdown-tabell placerar du markören i eller på tabellen i Markdown. Öppna kommandopaletten och sök Table: Format Current efter kommandot. När du väljer det kommandot uppdateras Markdown för tabellen för att justera och fylla tabellen för bättre läsbarhet.

Den konverterar en tabell som definierats så här:

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

In i detta:

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

Infoga en avisering

Dokumentationen använder aviseringar för att göra informationen mer anmärkningsvärd för en läsare.

Om du vill infoga en avisering kan du öppna kommandopaletten och söka Learn: Alert efter kommandot. När du väljer kommandot öppnas en snabbmeny. Välj den aviseringstyp som du vill lägga till. När du gör detta infogar kommandot varningens Markdown vid markören i dokumentet.

Gör en rubrik använda meningshölje

Om du vill konvertera en rubriks hölje markerar du rubrikens text förutom de inledande # symbolerna, som anger rubriknivån. När du har texten markerad öppnar du kommandopaletten och söker Change case sentence efter kommandot. När du väljer kommandot konverteras höljet för den markerade texten.

Du kan också använda höljekommandona för valfri text i dokumentet.

Öppna kommandopaletten

Du kan använda VS Code-kommandopaletten för att köra många användbara kommandon.

Om du vill öppna kommandopaletten i användargränssnittet väljer du "Visa" i den översta menyraden. Välj sedan "Kommandopalett..." i snabbmenyn.

Öppna kommandopaletten med tangentbordet genom att trycka på tangentkombinationen för operativsystemet:

  • Windows och Linux: Ctrl+Skift+P
  • macOS: Cmd+Shift+P

Förhandsgranska ditt bidrag

Om du vill förhandsgranska ditt bidrag öppnar du kommandopaletten och söker Markdown: Open Preview efter kommandot. När du väljer det kommandot öppnar VS Code en förhandsgranskning av det aktiva dokumentet. Förhandsgranskningens formatmall matchar Learn-plattformen.

Anmärkning

Platsrelativa länkar och korsreferenslänkar fungerar inte i förhandsversionen.

Flöda om ditt innehåll

Om du vill begränsa radlängderna för ett stycke i ett dokument placerar du markören på stycket. Öppna sedan kommandopaletten och sök Reflow Markdown efter kommandot. När du väljer kommandot uppdateras det aktuella styckets radlängder till den konfigurerade längden. För våra lagringsplatser är den längden 99 tecken.

När du använder det här kommandot för blockcitat kontrollerar du att stycket i blockcitatet som du flödar om omges av tomma rader. Annars flödar kommandot om varje stycke tillsammans.

Försiktighet

Använd inte det här kommandot när du redigerar artiklar. Raderna i dokumenten får inte vara längre än 80 tecken. Det finns för närvarande inget sätt för en lagringsplats att konfigurera olika radlängder efter mapp eller filnamn, så omflöde fungerar inte för artikeldokument.

Granska alla problem i ett dokument

Om du vill granska alla överträdelser av syntax- och formatregler i ett dokument öppnar du problemvyn.

Om du vill öppna problemvyn i användargränssnittet väljer du "Visa" i den översta menyraden. Välj sedan "Problem" på snabbmenyn.

Öppna problemvyn med tangentbordet genom att trycka på tangentkombinationen för operativsystemet:

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

I vyn Problem visas alla fel, varningar och förslag för det öppna dokumentet. Välj ett problem för att bläddra till det i dokumentet.

Du kan filtrera problemen efter typ- eller textmatchning.

Uppdatera metadata för ms.date

Om du vill uppdatera ms.date metadata för en artikel öppnar du kommandopaletten och söker Learn: Update "ms.date" Metadata Value efter kommandot. När du väljer kommandot uppdateras metadata till det aktuella datumet.

Ytterligare resurser

De uppgifter och kommandon som beskrivs i den här artikeln omfattar inte allt du kan göra med VS Code eller de installerade tilläggen.

Mer information om hur du använder VS Code finns i följande artiklar:

Mer information om de installerade tilläggen finns i deras dokumentation:

  • Last updated on