Bejelentjük a Docs Markdown bővítményt a Visual Studio Code-hoz
Ezt a bejegyzést Adam Kinney, a docs.microsoft.com csapat vezető szoftvermérnöke írta.
A mai napon örömmel jelentjük be, hogy megjelent a dokumentációkészítést segítő Docs Authoring Pack a Visual Studio Code-hoz, így egyszerűbb közreműködni a docs.microsoft.com tartalmának bővítésében, mint eddig bármikor. A csomag első kiadása három bővítményt tartalmaz:
- Docs Markdown – Markdown-segítséget nyújt a tartalomkészítéshez: a szövegformázáshoz, a lista- és táblázatbeszúráshoz, az egyéb tartalmakra mutató hivatkozások beszúrásához, valamint képek és más objektumok beszúrásához. Az egyéb Markdown-szerkesztőkkel ellentétben a Docs Markdown támogatja a docs.microsoft.com webhelyhez tartozó egyéni Docs Markdown-bővítményeket, például a riasztásokat és a kódrészleteket.
- DocFX – korlátozott docs.microsoft.com-specifikus Markdown-előnézetet biztosít, amely megmutatja, hogy a Markdown-fájl hogyan fog kinézni a publikáláskor.
- markdownlint – David Anson által fejlesztett Markdown linter, amely gondoskodik arról, hogy a Markdown-tartalom megfeleljen az ajánlott eljárásoknak.
Működési elv
Először telepítenie kell a Visual Studio Marketplace-ből. Amikor a bővítmény lapjára lép, egyszerűen kattintson az Install (Telepítés) lehetőségre, és kövesse a képernyőn megjelenő üzeneteket:
Ha végzett, egyszerűen töltse be újra a Visual Studio Code-ot, nyisson meg egy Markdown-fájlt, és már kezdheti is az írást! Használja az Alt+M billentyűkombinációt a Docs Markdown bővítmény parancspalettájának megjelenítéséhez eléréséhez, amellyel formázhatja a szöveget (pl. félkövérré vagy dőlt betűssé alakíthatja), beszúrhatja a szokványos Markdown-elemeket, például egy számozott listát vagy táblázatot, valamint docs-specifikus kódokat illeszthet be jegyzetekhez, fontos információkhoz és tippekhez:
Más fájlokból is gyorsan beszúrhat kódokat a DocFX-kompatibilis Markdown-bővítményeken keresztül, és közvetlenül a szerkesztőben megtekintheti azon dokumentum előnézetét, amelyen éppen dolgozik:
Közreműködés
A bővítmény nyílt forráskódú, és minden közreműködőt szívesen fogadunk!
A legtöbb közreműködés esetében el kell fogadnia egy közreműködői licencmegállapodást (Contributor License Agreement – CLA), amelyben megerősíti, hogy joga van, és ténylegesen feljogosít bennünket a közreműködés eredményének felhasználására. 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ú tárházra a CLA elfogadásával.
Visszajelzés
Van ötlete, hogy hogyan tehetnénk jobbá a bővítményünket? 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!