A VS Code-hoz használható Docs Authoring Pack új verziója

Ezt a bejegyzést Megan Bradley, a docs.microsoft.com csapat vezető programvezetője írta.

Áprilisban bejelentettük a Vs Code-hoz készült Docs Authoring Pack első kiadását, amely tartalmazza a Docs Markdown bővítményt, a DocFX-en alapuló szerkesztések előzetes verziójának bővítményét, valamint a markdownlintot. Ma örömmel jelentjük be a Docs Authoring Pack második nagy kiadását, amely a következő új bővítményeket tartalmazza:

  • Kód helyesírás-ellenőrző. Népszerű igény szerint ezt az offline helyesírás-ellenőrzőt a Street Side Software csomagba csomagoltuk, hogy a közreműködők az összes tartalmat, beleértve a kódmintákat is, anélkül, hogy ezt egy online szolgáltatáson keresztül kellene elvégezniük.
  • Docs-cikksablonok. Ez a bővítmény lehetővé teszi, hogy Markdown-sablont alkalmazzon egy új fájlra, így egyszerűbben hozhat létre tartalmakat és metaadatokat konzisztens módon.
  • Docs Preview. A Docs Authoring Pack első kiadásában szereplő DocFx előzetes verzió cseréje. Az új előzetes verziójú bővítmény sokkal robusztusabb, és nagyobb megbízhatóságú docs.microsoft.com CSS-t képvisel.

A bővítményeket egyenként, a fenti hivatkozásokon keresztül vagy egyetlen csomagban telepítheti a Docs szerzői csomagon keresztül.

A cikksablonok bemutatása

A cikksablonok olyan markdown-fájlok, amelyek szabványos címsorokat, fájl metaadatokat, sablonszövegeket és egyéb alapvető elemeket tartalmaznak, amelyek az docs.microsoft.com irányelveket követik, megkönnyítve az új cikkekhez való hozzájárulást, és kiküszöbölik a találgatásokat a közzétételi követelmények alól!

Ha egy kilépő sablon alapján szeretne új fájlt létrehozni, egyszerűen nyomja le az Alt+M billentyűt, és válassza a Sablon lehetőséget:

sablon alkalmazása

Jobb előzetes verzió

A korábbi DocFX-alapú előzetes motort az új Docs Preview váltotta fel, amely a következő fejlesztéseket tartalmazza:

  • A CommonMark-kompatibilis Markdig-elemző támogatása a DocFx-flavored Markdown (DFM) helyett.
  • Naprakész docs.microsoft.com CSS-sel, az egyéni Markdown-elemek nagyobb hűséggel való megjelenítésével.
  • Javítottuk a megbízhatóságot, így az előnézetek gyorsabban és késés nélkül renderelhetők.
  • A Docs-specifikus Markdown-bővítmények egyre bővülő listájának támogatása, amint azok elérhetővé válnak.

Közreműködés

A Docs Markdown-bővítmények nyílt forráskódúak – örömmel fogadjuk a közreműködéseket!

Ne feledje, hogy a legtöbb hozzájárulás megköveteli, hogy ön elfogadja a közreműködői licencszerződést (CLA), amely megerősíti, hogy jogosult arra, és ténylegesen meg is adja nekünk a jogot, hogy felhasználjuk a hozzájárulást a szoftvereinkben és a tartalmainkban. További részletekért lásd: https://cla.microsoft.com. A lekéréses kérelmek elküldésekor egy CLA-robot automatikusan meghatározza, hogy kell-e biztosítania CLA-t, és megfelelően kitölti a lekéréses kérelmet (például címke, megjegyzés). Egyszerűen csak kövesse a robot által megadott utasításokat. Ezt csak egyszer kell elvégeznie az összes Microsoft-tulajdonú adattárban.

Visszajelzés

Van gondolata arról, hogyan lehet jobbá tenni a bővítményeket? Egyszerűen nyisson egy új problémát!

A legújabb híreket a Twitter-fiókunkban találja.

Azon szeretne dolgozni, hogy megkönnyítse a fejlesztők munkáját? Csatlakozzon a csapatunkhoz!