Nowa wersja pakietu Docs Authoring Pack dla programu VS Code

  • Artykuł

Ten post został napisany przez Megan Bradley, starszy menedżer programu w zespole docs.microsoft.com.

W kwietniu ogłosiliśmy pierwszą wersję pakietu Docs Authoring Pack dla programu VS Code, która obejmuje rozszerzenie Docs Markdown, rozszerzenie do podglądu edycji oparte na docFX, a także markdownlint. Dzisiaj z przyjemnością ogłaszamy drugą główną wersję pakietu Docs Authoring Pack, która zawiera następujące nowe rozszerzenia:

  • Moduł sprawdzania pisowni kodu. Według popularnego zapotrzebowania dołączyliśmy ten moduł sprawdzania pisowni w trybie offline firmy Street Side Software, dzięki czemu współautorzy mogą sprawdzać pisownię całej zawartości, w tym przykłady kodu, bez konieczności wykonywania tych czynności za pośrednictwem usługi online.
  • Szablony artykułów witryny Docs. To rozszerzenie umożliwia zastosowanie szablonu języka Markdown do nowego pliku, co ułatwia tworzenie zawartości i metadanych w spójny sposób.
  • Dokumentacja w wersji zapoznawczej. Zastąpienie wersji zapoznawczej narzędzia DocFx zawartego w pierwszej wersji pakietu Docs Authoring Pack. Nowe rozszerzenie w wersji zapoznawczej jest znacznie bardziej niezawodne i reprezentuje docs.microsoft.com CSS w wyższej wierności.

Rozszerzenia można zainstalować indywidualnie za pośrednictwem powyższych linków lub w jednym pakiecie za pośrednictwem pakietu Docs Authoring Pack.

Wprowadzenie do szablonów artykułów

Szablony artykułów to szkielet plików markdown, które udostępniają standardowe nagłówki, metadane plików, standardowy tekst i inne podstawowe elementy zgodne z wytycznymi docs.microsoft.com, co ułatwia tworzenie nowych artykułów i eliminowanie zgadywania z wymagań dotyczących publikowania.

Aby utworzyć nowy plik na podstawie szablonu zakończenia, po prostu naciśnij klawisze Alt+M i wybierz pozycję Szablon:

stosowanie szablonu

Lepszy podgląd

Poprzedni aparat docFX w wersji zapoznawczej został zastąpiony zupełnie nowym aparatem docs Preview, który oferuje następujące ulepszenia:

  • Obsługa analizatora Markdig zgodnego ze standardem CommonMark zamiast języka Markdown o smaku DocFx (DFM).
  • Aktualne docs.microsoft.com CSS, renderowanie niestandardowych elementów języka Markdown o wyższej wierności.
  • Większa niezawodność, dzięki czemu podglądy są renderowane szybciej i bez opóźnień.
  • Obsługa stale rosnącej listy rozszerzeń języka Markdown specyficznych dla witryny Docs, ponieważ stają się one dostępne.

Współtworzenie

Rozszerzenia języka Markdown witryny Docs są typu open source — zapraszamy do współtworzenia!

Należy pamiętać, że większość kontrybucja wymaga zgody na zgodę na umowę licencyjną współautora (CLA), potwierdzając, że masz prawo, a w rzeczywistości przyznaj nam prawa do korzystania z twojego udziału w oprogramowaniu i zawartości. Aby uzyskać szczegółowe informacje, odwiedź stronę https://cla.microsoft.com. Po przesłaniu żądania ściągnięcia robot CLA automatycznie określi, czy musisz przekazać umowę CLA, i doda odpowiednie informacje do tego żądania (na przykład etykietę czy komentarz). Po prostu postępuj zgodnie z instrukcjami robota. Należy to zrobić tylko raz we wszystkich repozytoriach należących do firmy Microsoft.

Opinia

Masz przemyślenia na temat tego, jak możemy ulepszyć rozszerzenia? Po prostu otwórz nowe zgłoszenie.

Nie zapomnij też 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!