Przedstawienie rozszerzenia Docs Markdown dla programu Visual Studio Code

Ten wpis został napisany przez Adama Kinney’a, starszego inżyniera oprogramowania w zespole witryny docs.microsoft.com.

Dziś z radością informujemy o wydaniu pakietu Docs Authoring Pack dla programu Visual Studio Code, który sprawia, że współtworzenie zawartości witryny docs.microsoft.com jest łatwiejsze niż kiedykolwiek. To pierwsze wydanie pakietu zawiera trzy rozszerzenia:

  • Docs Markdown — pomaga przy tworzeniu zawartości w języku znaczników Markdown, w tym przy formatowaniu tekstu, wstawianiu list i tabel, wstawianiu linków do innej zawartości i dodawaniu obrazów oraz innych zasobów. W odróżnieniu od innych edytorów języka znaczników Markdown, rozszerzenie Docs Markdown obsługuje niestandardowe rozszerzenia języka znaczników Markdown dla witryny docs.microsoft.com, takie jak alerty i fragmenty kodu.
  • DocFX — zapewnia ograniczony podgląd języka znaczników Markdown specyficzny dla witryny docs.microsoft.com. Dzięki niemu zobaczysz, jak Twój plik w języku Markdown będzie wyglądać po opublikowaniu.
  • markdownlint — popularny linter języka znaczników Markdown autorstwa Davida Ansona, który pomaga zagwarantować, że Twój język znaczników Markdown jest zgodny z najlepszymi rozwiązaniami.

Jak to działa

Najpierw trzeba zainstalować rozszerzenie z witryny Visual Studio Marketplace. Po przejściu na stronę rozszerzenia wystarczy kliknąć pozycję Zainstaluj i postępować zgodnie z komunikatami na ekranie:

Instalowanie rozszerzenia Docs Markdown

Po zakończeniu załaduj ponownie program Visual Studio Code, otwórz plik w języku znaczników Markdown i zacznij pisać. Używaj kombinacji klawiszy Alt+M, aby uzyskiwać dostęp do palety poleceń rozszerzenia Docs Markdown, które pozwalają szybko sformatować tekst (np. go pogrubić lub pochylić), wstawić standardowe jednostki języka znaczników Markdown, takie jak lista numerowana lub tabela, a także wstawić specyficzny dla witryny Docs kod w języku znaczników dla uwag, ważnych informacji i porad:

Paleta poleceń rozszerzenia

Możesz też szybko wstawić kod z innych plików za pośrednictwem rozszerzenia języka znaczników Markdown zgodnego z DocFX i wyświetlić podgląd strony, nad którą pracujesz, bezpośrednio w edytorze:

Podgląd aktualnie edytowanej strony

Współtworzenie

Rozszerzenie jest typu open source i zachęcamy do jego rozwijania.

Większość wprowadzanych modyfikacji będzie wymagać od Ciebie wyrażenia zgody na umowę licencyjną współautora (CLA), która potwierdza, że masz prawa do tych modyfikacji i że przyznajesz nam prawa do korzystania z nich. Aby uzyskać szczegółowe informacje, odwiedź stronę https://cla.microsoft.com.

Gdy prześlesz żądanie ściągnięcia, bot CLA automatycznie określi, czy musisz wyrazić zgodę na umowę CLA, i doda odpowiednią informację do żądania ściągnięcia (np. w formie etykiety lub komentarza). Postępuj wtedy zgodnie z instrukcjami wyświetlanymi przez bota. Czynność tę wystarczy wykonać raz dla wszystkich repozytoriów firmy Microsoft objętych umową CLA.

Opinie

Masz pomysł na to, jak firma Microsoft może ulepszyć to rozszerzenie? Po prostu otwórz nowy problem.

I nie zapomnij obserwować naszego konta na Twitterze, aby być na bieżąco z nowościami.

Marzysz o uczynieniu świata lepszym miejscem dla deweloperów? Dołącz do naszego zespołu!