Přispívání pomocí GitHub Codespaces

GitHub má funkci s názvem Codespaces , kterou můžete použít k přispívání do dokumentace k PowerShellu, aniž byste museli instalovat nebo konfigurovat jakýkoli software místně. Když používáte codespace, získáte stejné nástroje pro vytváření, které tým používá k psaní a úpravám.

V prohlížeči můžete použít codespace a vytvářet příspěvky v editoru VS Code hostované přes internet. Pokud máte VS Code nainstalovaný místně, můžete se také připojit k prostoru kódu.

Dostupné nástroje

Když k přispívání do dokumentace k PowerShellu použijete codespace, váš editor už má tyto nástroje k dispozici:

Náklady

GitHub Codespaces je možné používat zdarma až do 120 jader-hodin měsíčně. Měsíční využití se počítá ve všech úložištích, ne jenom v dokumentaci.

Další informace o cenách najdete v tématu Fakturace pro GitHub Codespaces.

Návod

Pokud používáte kontejnery a Docker, můžete získat stejné prostředí pomocí devcontaineru definovaného pro úložiště dokumentace k PowerShellu. S používáním devcontainerů nejsou spojené žádné náklady. Další informace najdete v kurzu Dev Containers.

Vytvoření prostředí Codespace na GitHubu

Pokud chcete vytvořit GitHub Codespace pro přispívání do dokumentace k PowerShellu, postupujte takto:

  1. Otevřete https://github.com/codespaces v prohlížeči.
  2. V pravém horním rohu stránky vyberte tlačítko "Nový kódový prostor".
  3. Na stránce Vytvořit nový prostor kódu vyberte tlačítko Vybrat úložiště a zadejte název úložiště, do kterého chcete přispívat, například MicrosoftDocs/PowerShell-Docs.
  4. Ponechte všechna ostatní nastavení jako výchozí.
  5. Vyberte tlačítko Vytvořit codespace.

Po provedení těchto kroků GitHub vytvoří pro toto úložiště nový prostor kódu a nastaví ho za vás. Jakmile je codespace připraven, stránka se aktualizuje a zobrazí uživatelské rozhraní webového editoru pro codespace. Uživatelské rozhraní je založené na VS Code a funguje stejně.

Otevření GitHub Codespace

Pokud chcete otevřít GitHub Codespace v prohlížeči, postupujte takto:

  1. Otevřete https://github.com/codespaces v prohlížeči.
  2. Na stránce jsou uvedeny vaše Codespaces. Vyhledejte vytvořený prostor kódu pro úložiště, do kterého chcete přispívat, a vyberte ho.

Jakmile vyberete svůj prostor kódu, GitHub ho otevře ve stejném okně. Odsud jste připraveni přispívat.

Pokud chcete otevřít GitHub Codespace ve VS Code, postupujte podle kroků v části Používání GitHub Codespaces ve Visual Studio Code.

Vytváření obsahu v GitHub Codespace

Jakmile máte v prohlížeči nebo VS Code otevřené prostředí GitHub Codespace, přispívání do dokumentace se řídí stejným procesem.

Zbytek tohoto článku popisuje výběr úkolů, které můžete dělat ve svém GitHub Codespace při psaní nebo úpravách příspěvku.

Pokud chcete převést vložený odkaz, jako je například [some text](destination.md), na referenční odkaz, jako je [some text][01], vyberte cíl odkazu v editoru. Pak můžete:

  1. Klikněte pravým tlačítkem na cíl odkazu a vyberte "Refactor..." v kontextové nabídce.
  2. Stiskněte kombinaci kláves Ctrl+Shift+R.

Obě akce vyvolají místní nabídku refaktoringu. Chcete-li nahradit (destination.md) v odkazu [def], vyberte extrahovat definici propojení v místní nabídce. Definici můžete přejmenovat zadáním názvu.

V dokumentaci k PowerShellu používáme definice dvoumístných číselných odkazů, například [01] nebo [31]. V článcích a koncepční dokumentaci používejte pouze definice referenčních odkazů. V referenční dokumentaci k cmdletům nepoužívejte definice odkazů.

Oprava porušení stylu prose

Když si prohlédnete článek v codespace, Vale automaticky zkontroluje článek při prvním otevření a pokaždé, když ho uložíte. Pokud Vale najde nějaká porušení stylu, zvýrazní je v dokumentu barevnými vlnovkami.

Když najedete myší na porušení, zobrazí se další informace.

Pokud chcete otevřít webovou stránku s vysvětlením pravidla, vyberte název pravidla v informacích o přechodu myší. Pokud chcete pravidlo otevřít a zkontrolovat jeho implementaci, vyberte název souboru pravidla (končící na .yml).

Pokud pravidlo podporuje rychlou opravu, můžete v informačním rámečku po najetí myší na porušení vybrat "Rychlá oprava..." a použít jednu z navrhovaných oprav tak, že ji vyberete z místní nabídky. Můžete také stisknout Ctrl+. Když je kurzor na zvýrazněném problému, lze použít rychlou opravu, pokud to pravidlo podporuje.

Pokud pravidlo nepodporuje rychlé opravy, přečtěte si zprávu pravidla a v případě potřeby ji opravte. Pokud si nejste jistí, jak ho opravit, editoři mohou při kontrole vašeho PR navrhnout řešení.

Řešení problémů se syntaxí

Když si prohlédnete článek v codespace, Markdownlint automaticky zkontroluje článek při jeho otevření a při psaní. Pokud Markdownlint najde nějaké problémy se syntaxí, zvýrazní je v dokumentu barevnými vlnovkami.

Když najedete myší na porušení, zobrazí se další informace. Pokud chcete otevřít webovou stránku s vysvětlením pravidla, vyberte ID pravidla v informacích o přechodu myší.

Pokud pravidlo podporuje rychlou opravu, můžete v informačním rámečku po najetí myší na porušení vybrat "Rychlá oprava..." a použít jednu z navrhovaných oprav tak, že ji vyberete z místní nabídky. Můžete také stisknout Ctrl+. Když je kurzor na zvýrazněném problému, lze použít rychlou opravu, pokud to pravidlo podporuje.

Pokud pravidlo nepodporuje rychlé opravy, přečtěte si zprávu pravidla a v případě potřeby ji opravte. Pokud si nejste jistí, jak ho opravit, editoři mohou při kontrole vašeho PR navrhnout řešení.

Opravy můžete použít také u všech porušení syntaxe v článku. Uděláte to tak, že otevřete paletu příkazů a zadáte Fix all supported markdownlint violations in the document. Při psaní paleta příkazů filtruje dostupné příkazy. Vyberte příkaz Opravit všechny podporované chyby markdownlintu v dokumentu. Když to uděláte, Markdownlint aktualizuje dokument pro vyřešení případných porušení, pro která má rychlou opravu.

Formátování tabulky

Pokud chcete formátovat tabulku Markdownu, umístěte kurzor do tabulky nebo na tabulku v Markdownu. Otevřete paletu příkazů a vyhledejte Table: Format Current příkaz. Když tento příkaz vyberete, aktualizuje Markdown pro vaši tabulku tak, aby tabulku zarovnal a přidal odsazení, čímž se zlepší čitelnost.

Převede tabulku definovanou takto:

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

Do tohoto:

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

Vložení upozornění

Dokumentace používá výstrahy ke zvýraznění informací, aby byly pro čtenáře nápadnější.

Pokud chcete vložit upozornění, můžete otevřít paletu příkazů a vyhledat Learn: Alert příkaz. Když tento příkaz vyberete, otevře se místní nabídka. Vyberte typ upozornění, který chcete přidat. Když to uděláte, příkaz vloží Markdown upozornění do pozice kurzoru v dokumentu.

Vyrobte nadpis s použitím malých písmen jako u vět

Pokud chcete převést velikost písmen nadpisu, zvýrazněte text nadpisu s výjimkou úvodních # symbolů, které nastavují úroveň nadpisu. Až text zvýrazníte, otevřete paletu příkazů a vyhledejte Change case sentence příkaz. Když tento příkaz vyberete, převede velikost písmen zvýrazněného textu.

Můžete také použít příkazy pro změnu velikosti písmen pro libovolný text v dokumentu.

Otevření palety příkazů

Paletu příkazů VS Code můžete použít ke spouštění mnoha užitečných příkazů.

Pokud chcete otevřít paletu příkazů v uživatelském rozhraní, vyberte v horním řádku nabídek možnost Zobrazit. Pak vyberte "Paleta příkazů..." v místní nabídce.

Paletu příkazů otevřete pomocí klávesnice stisknutím kombinace kláves pro váš operační systém:

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

Náhled příspěvku

Pokud chcete zobrazit náhled příspěvku, otevřete paletu příkazů a vyhledejte Markdown: Open Preview příkaz. Když tento příkaz vyberete, nástroj VS Code otevře náhled aktivního dokumentu. Styl náhledu odpovídá platformě „Learn“.

Poznámka:

Odkazy závislé na webu a křížové odkazy nefungují v náhledu.

Upravit tok obsahu

Pokud chcete omezit délky řádků odstavce v dokumentu, umístěte kurzor na odstavec. Pak otevřete paletu příkazů a vyhledejte Reflow Markdown příkaz. Když vyberete příkaz, aktualizuje délku řádku aktuálního odstavce na nakonfigurovanou délku. U našich úložišť je tato délka 99 znaků.

Při použití tohoto příkazu pro blokové uvozovky se ujistěte, že odstavec v uvozovkách bloku, který přeformátujete, je obklopen prázdnými řádky. Jinak příkaz přeformátuje všechny odstavce do jednoho celku.

Upozornění

Tento příkaz nepoužívejte při úpravách článků. Řádky v těchto dokumentech nesmí být delší než 80 znaků. V současné době neexistuje způsob, jak úložiště nakonfigurovat různé délky řádků podle složky nebo názvu souboru, takže přeformátování nefunguje pro dokumenty článků.

Kontrola všech problémů v dokumentu

Pokud chcete zkontrolovat všechna porušení pravidel syntaxe a stylu v dokumentu, otevřete zobrazení Problémů.

Pokud chcete otevřít zobrazení problémů v uživatelském rozhraní, vyberte v horním řádku nabídek možnost Zobrazit. Pak v místní nabídce vyberte "Problémy".

Pokud chcete otevřít zobrazení problémů pomocí klávesnice, stiskněte kombinaci kláves pro váš operační systém:

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

Zobrazení problémů zobrazí všechny chyby, upozornění a návrhy otevřeného dokumentu. Vyberte problém a posuňte se k němu v dokumentu.

Problémy můžete filtrovat podle typu nebo shody textu.

Aktualizace metadat ms.date

Pokud chcete aktualizovat ms.date metadata článku, otevřete paletu příkazů a vyhledejte Learn: Update "ms.date" Metadata Value příkaz. Když vyberete příkaz, aktualizuje metadata na aktuální datum.

Další zdroje informací

Úlohy a příkazy popsané v tomto článku nepokrývají všechno, co můžete dělat s VS Code nebo nainstalovanými rozšířeními.

Další informace o používání nástroje VS Code najdete v těchto článcích:

Další informace o nainstalovaných rozšířeních najdete v dokumentaci:

  • Last updated on