Ogłoszenie rozszerzenia Języka Markdown witryny Docs dla programu Visual Studio Code

Ten wpis został napisany przez Adam Kinney, starszy inżynier oprogramowania w zespole docs.microsoft.com.

Dzisiaj z przyjemnością ogłaszamy wydanie Docs Authoring Pack dla programu Visual Studio Code, co ułatwia współtworzenie docs.microsoft.com. Ta pierwsza wersja pakietu zawiera trzy rozszerzenia:

• docs Markdown — zapewnia pomoc w tworzeniu języka Markdown, w tym formatowanie tekstu, wstawianie list i tabel, wstawianie linków do innej zawartości oraz dodawanie obrazów i innych zasobów. W przeciwieństwie do innych edytorów języka Markdown język Docs Markdown obsługuje niestandardowe rozszerzenia języka Markdown dla docs.microsoft.com, takie jak alerty i fragmenty kodu.
• DocFX — udostępnia ograniczoną docs.microsoft.com— konkretną wersję zapoznawcza języka Markdown, aby zobaczyć, jak będzie wyglądał plik Markdown po opublikowaniu.
• markdownlint — popularny linter języka Markdown David Anson, aby zapewnić, że język Markdown jest zgodny z najlepszymi rozwiązaniami.

Jak to działa

Najpierw należy zainstalować ją z witryny Visual Studio Marketplace. Po przejściu do strony rozszerzenia po prostu kliknij pozycję Zainstaluj i postępuj zgodnie z komunikatami na ekranie:

Po zakończeniu należy ponownie załadować program Visual Studio Code, otworzyć plik Markdown i rozpocząć pisanie! Użyj kombinacji Alt+M, aby uzyskać dostęp do palety poleceń rozszerzenia Języka Markdown witryny Docs, umożliwiając szybkie formatowanie tekstu (np. pogrubienie lub kursywę), wstawianie standardowych jednostek języka Markdown, takich jak lista numerowana lub tabela, a także wstawianie znaczników specyficznych dla dokumentów dla notatek, ważnych informacji i porad:

Możesz również szybko wstawić kod z innych plików za pośrednictwem rozszerzenia markdown zgodnego z DocFXi wyświetlić podgląd strony, nad którą pracujesz bezpośrednio w edytorze:

Przyczynić się

Rozszerzenie jest open source i z zadowoleniem przyjmujemy wszelkie jego wkłady!

Większość składek wymaga zgody na umowę licencyjną współautora (CLA), potwierdzając, że masz prawo, a w rzeczywistości przyznaj nam prawa do korzystania z twojego wkładu. Aby uzyskać szczegółowe informacje, odwiedź stronę https://cla.microsoft.com.

Po przesłaniu żądania ściągnięcia bot CLA automatycznie określi, czy musisz podać cla i odpowiednio ozdobić żądanie ściągnięcia (np. etykieta, komentarz). Po prostu postępuj zgodnie z instrukcjami dostarczonymi przez bota. Należy to zrobić tylko raz we wszystkich repozytoriach należących do firmy Microsoft przy użyciu naszego cla.

Prześlij opinię

Masz przemyślenia na temat tego, jak możemy ulepszyć rozszerzenie? Po prostu otworzyć nowy problem!

Nie zapomnij śledzić naszych konta twitter najnowszych aktualizacji.

Marzysz o tym, aby świat był lepszy dla deweloperów? dołącz do naszego zespołu!