Zdieľať cez

Learn Authoring Pack for Visual Studio Code

  • Článok

Balík na tvorbu informácií na lokalite Learn je kolekcia rozšírení pre Visual Studio Code na pomoc pri tvorbe v jazyku Markdown pre obsah služby Microsoft Learn. Balík je k dispozícii v obchode VS Code a obsahuje nasledovné rozšírenia:

  • Learn Markdown: poskytuje pomoc pri tvorbe obsahu v jazyku Markdown v službe Microsoft Learn vrátane podpory pre základnú syntax jazyka Markdown, ako aj vlastnú syntax jazyka Markdown, ako sú upozornenia, úryvky kódu a ne lokalizovateľný text. Teraz obsahuje aj základnú pomoc pri tvorbe v službe YAML, ako je napríklad vkladanie položiek obsahu.
  • markdownlint: Populárny kódovač jazyka Markdown od Davida Ansona, ktorý pomáha zabezpečiť, že váš jazyk Markdown je platný.
  • Code Spell Checker: Nástroj na kontrolu pravopisu od firmy Street Side Software, plne dostupný offline.
  • Learn Preview: Rozšírenie, ktoré využíva jazyk CSS služby Microsoft Learn s informáciami o presnejších ukážkach jazyka Markdown vrátane vlastného jazyka Markdown.
  • Learn Article Templates: Umožňuje používateľom podporne používať moduly Learn a použiť kostru obsahu v jazyku Markdown v nových súboroch.
  • Informácie o yaml: poskytuje overenie schémy YAML a automatické dokončovanie.
  • Learn Images: Poskytuje kompresiu a zmenu veľkosti obrázkov pre priečinky a jednotlivé súbory na pomoc autorom obsahu Microsoft Learn.

Požiadavky a predpoklady

Ak chcete vložiť relatívne prepojenia, obrázky a iný vložený obsah s rozšírením jazyka Markdown služby Learn, musíte mať pracovný priestor nástroja VS Code nastavený na koreň svojho klonovaného odkladacieho priestoru Open Publishing System (OPS). Ak ste napríklad klonovali odkladací priestor dokumentov do C:\git\SomeDocsRepo\, potom otvorte tento priečinok alebo podpriečinok v nástroji VS Code: ponuka File Open Folder (Otvoriť priečinok)>alebo code C:\git\SomeDocsRepo\ z príkazového riadka.

Niektorá syntax podporovaná rozšírením, ako napríklad upozornenia a úryvky, sú vlastné kódy jazyka Markdown pre OPS. Vlastný jazyk Markdown sa nevykreslí správne, pokiaľ nie je publikovaný cez OPS.

Ako používať rozšírenie jazyka Markdown na lokalite Learn

Ak chcete získať prístup k ponuke jazyka Markdown na lokalite Learn, zadajte kláves Alt+M. Požadovaný príkaz môžete vybrať kliknutím alebo pomocou šípok nahor a nadol. Môžete tiež začať písať a spustiť tak filtrovanie. Keď sa v ponuke zvýrazní požadovaná funkcia, stlačte kláves ENTER.

Aktuálny zoznam príkazov nájdete v readme jazyka Markdown na lokalite Learn.

Ako vygenerovať hlavný súbor presmerovania

Rozšírenie jazyka Markdown na lokalite Learn obsahuje skript na generovanie alebo aktualizáciu hlavného súboru presmerovania pre odkladací priestor na redirect_url základe metaúdajov v jednotlivých súboroch. Tento skript skontroluje každý súbor jazyka Markdown v odkladacom priestore pre redirect_url, pridá metaúdaje presmerovania do hlavného súboru presmerovania (.openpublishing.redirection.json) pre odkladací priestor a premiestni presmerované súbory do priečinka mimo odkladacieho priestoru. Spustenie skriptu:

  1. Výberom možnosti F1 otvorte paletu príkazov programu VS Code.
  2. Začnite písať "Learn: Generate..." (Generovať...).
  3. Vyberte príkaz Learn: Generate main redirection file.
  4. Po dokončení spustenia skriptu sa výsledky presmerovania zobrazia na výstupnej table programu VS Code a odstránené súbory jazyka Markdown sa pridajú do priečinka Learn Authoring\redirects v rámci vašej predvolenej cesty.
  5. Skontrolujte výsledky. Ak spĺňajú očakávania, odošlite žiadosť o prijatie zmien na aktualizáciu odkladacieho priestoru.

Ako priradiť klávesové skratky

  1. Stlačením klávesov Ctrl+K a potom Ctrl+S otvorte zoznam Klávesové skratky.

  2. Vyhľadajte príkaz, ako napríklad formatBold, pre ktorý chcete vytvoriť vlastné priradenie klávesu.

  3. Kliknite na znamienko plus, ktoré sa zobrazí vedľa názvu príkazu, keď umiestníte kurzor myši nad riadok.

  4. Keď sa zobrazí nové vstupné poľa, zadajte klávesovú skratku, ktorú chcete priradiť k danému príkazu. Ak chcete napríklad použiť spoločnú skratku pre tučné písmo, zadajte kláves Ctrl+B.

  5. Odporúča sa vložiť klauzulu when do priradenia klávesu, aby nebol k dispozícii v súboroch iných ako v jazyku Markdown. Ak to chcete urobiť, otvorte keybindings.json a pod názov príkazu vložte nasledujúci riadok (nezabudnite medzi riadky pridať čiarku):

    "when": "editorTextFocus && editorLangId == 'markdown'"

    Hotové vlastné priradenie klávesu by v súbore keybindings.json malo vyzerať takto:

    [
    {
        "key": "ctrl+b",
        "command": "formatBold",
        "when": "editorTextFocus && editorLangId == 'markdown'"
    }
]

    Prepitné

    Umiestnenie kľúčových väzieb v tomto súbore na prepísanie predvolených hodnôt

  6. Uložte súbor keybindings.json.

Ďalšie informácie o priradeniach klávesov nájdete v dokumentoch pre VS Code.

Ako zobraziť starší panel s nástrojmi „Rukavica“

Bývalí používatelia rozšírenia s kódovým názvom "Rukavica" si všimnú, že panel s nástrojmi na tvorbu sa už nezobrazuje v dolnej časti okna programu VS Code, keď je nainštalované rozšírenie jazyka Markdown na lokalite Learn. Je to preto, že panel s nástrojmi zaberal veľký priestor v stavovom riadku programu VS Code a nepoužíval najvhodnejšie postupy pre používateľské rozhranie rozšírení. To znamená, že v novom rozšírení sa už nebude používať. Panel s nástrojmi však môžete voliteľne zobraziť tak, že nasledovným spôsobom aktualizujete svoj súbor settings.json programu VS Code:

  1. V nástroji VS Code prejdite na položku Predvoľby> súborov>Nastavenia alebo vyberte kláves Ctrl.+

  2. Vyberte položku Používateľské nastavenia a zmeňte nastavenia pre všetky pracovné priestory programu VS Code alebo vyberte Nastavenia pracovného priestoru a zmeňte ich iba pre aktuálny pracovný priestor.

  3. Vyberte položku Rozšírenia>Naučte sa konfiguráciu rozšírenia jazyka Markdown a potom v dolnom stavovom riadku vyberte položku Zobraziť starší panel s nástrojmi.

    Show legacy toolbar setting in VS Code

Keď vykonáte výber, VS Code aktualizuje súbor settings.json. Potom sa zobrazí výzva na opätovné načítanie okna, aby sa zmeny prejavili.

Novšie príkazy pridané do rozšírenia nebudú na paneli s nástrojmi dostupné.

Ako používať šablóny služby Learn

Rozšírenie Šablóna článku na lokalite Learn umožňuje autorom v nástroji VS Code vyžiadať si šablónu jazyka Markdown z centralizovaného ukladacieho priestoru a použiť ju na súbor. Šablóny vám pomôžu zabezpečiť to, že požadované metaúdaje budú súčasťou článkov, dodržia sa štandardy obsahu atď. Šablóny sú spravované ako súbory v jazyku Markdown v odkladacom priestore GitHub.

Použitie šablóny v programe VS Code

  1. Uistite sa, že rozšírenie Šablóna článku služby Learn je nainštalované a povolené.
  2. Ak nemáte nainštalované rozšírenie jazyka Markdown na lokalite Learn, kliknutím na kláves F1 otvorte paletu príkazov. Do filtra zadajte slovo "template" a potom kliknite na položku Learn: Template. Ak máte nainštalované rozhranie Markdown learn, môžete použiť buď paletu príkazov, alebo kliknite na tlačidlo Alt+M a vyvolajte ponuku QuickPick v jazyku Markdown na lokalite Learn. Potom vyberte zo zoznamu položku .Template
  3. Zo zobrazeného zoznamu vyberte požadovanú šablónu.

Pridanie ID GitHubu alebo aliasu služby Microsoft do vašich nastavení programu VS Code

Rozšírenie Šablóny podporuje tri dynamické polia metaúdajov: author, ms.author a ms.date. To znamená, že pokiaľ tvorca šablóny použije tieto polia v hlavičke metaúdajov šablóny v jazyku Markdown, keď použijete danú šablónu, automaticky sa vo vašom súbore tieto polia vyplnia, a to nasledovne:

Pole metaúdajov Hodnota
author Váš alias služby GitHub, ak je špecifikovaný v súbore nastavení programu VS Code.
ms.author Váš alias spoločnosti Microsoft, ak je špecifikovaný v súbore nastavení programu VS Code. Ak nie ste zamestnancom spoločnosti Microsoft, ponechajte pole prázdne.
ms.date Aktuálny dátum v podporovanom formáte MM/DD/YYYY. Dátum sa neaktualizuje automaticky, keď následne aktualizujete súbor, ale musíte ho aktualizovať manuálne. Toto pole slúži na označenie aktuálnosti článku.

Nastavenie ako author a/alebo ms.author

  1. V nástroji VS Code prejdite na položku Predvoľby> súborov>Nastavenia alebo vyberte kláves Ctrl.+
  2. Vyberte položku Používateľské nastavenia a zmeňte nastavenia pre všetky pracovné priestory programu VS Code alebo vyberte nastavenia pracovného priestoru a zmeňte ich iba pre aktuálny pracovný priestor.
  3. Vľavo na table Predvolené Nastavenia vyhľadajte položku Konfigurácia rozšírenia Learn Article Templates, kliknite na ikonu ceruzky vedľa požadovaného nastavenia a potom v Nastavenia kliknite na položku Nahradiť.
  4. V postrannom okne sa otvorí tabla Používateľské nastavenia s novou položkou v dolnej časti.
  5. Pridajte svoje ID služby GitHub alebo e-mailový alias spoločnosti Microsoft, podľa toho, čo je vhodnejšie, a súbor uložte.
  6. Možno budete musieť zavrieť a reštartovať program VS Code, aby sa prejavili zmeny.
  7. Keď teraz použijete šablónu, ktorá používa dynamické polia, vaše pole ID služby GitHub alebo alias spoločnosti Microsoft bude automaticky vyplnené v hlavičke metaúdajov.

Sprístupnenie novej šablóny v programe VS Code

  1. Navrhne šablónu ako súbor jazyka Markdown.
  2. Odošlite žiadosť o prijatie zmien do priečinka šablóny v odkladacom priestore MicrosoftDocs/content-templates.

Tím zodpovedný za obsah skontroluje vašu šablónu a žiadosť o prijatie zmien zlúči, ak spĺňa pokyny týkajúce sa štýlu. Po zlúčení bude šablóna k dispozícii pre všetkých používateľov rozšírenia Šablóny článku na lokalite Learn.

Ukážka viacerých funkcií

Tu je krátke video, ktoré znázorňujú nasledujúce funkcie Balíka na vytváranie informácií:

  • Súbory YAML
    • Podpora pre "Vzdelávanie: Prepojenie na súbor v odkladacom priestore"
  • Súbory jazyka Markdown
    • Aktualizácia možnosti kontextovej ponuky hodnoty metaúdajov ms.date
    • Podpora automatického dokončovania kódu pre identifikátory jazyka ohradenia kódu
    • Upozornenia na nerozpoznaný identifikátor jazyka ohradenia kódu/podpora automatických opráv
    • Zoradiť výber vzostupne (od A po Z)
    • Zoradenie výberu zostupne (od Z po A)

Ďalšie kroky

Preskúmajte rôzne funkcie, ktoré sú k dispozícii v balíku na vytváranie obsahu Learn, rozšírení programu Visual Studio Code.