Omówienie platformy PlatyPS

PlatyPS to podstawowe narzędzie do tworzenia pomocy programu PowerShell wyświetlanej przy użyciu Get-Help. Pliki pomocy programu PowerShell są zapisywane w formacie Microsoft Assistance Markup Language (MAML). Język MAML definiuje schemat XML dla struktury plików pomocy.

Istnieją dwie główne wersje platformy PlatyPS.

• Microsoft.PowerShell.PlatyPS v1.0.1 to obsługiwana wersja PlatyPS. Ta wersja jest kompletnym ponownym zapisywaniem w języku C# przy użyciu markdig na potrzeby analizowania języka Markdown. Ta wersja zawiera kilka ulepszeń:
  • Zawiera dokładniejszy opis polecenia cmdlet programu PowerShell i jego parametrów
  • Zwiększona wydajność — procesy 1000 plików Markdown w sekundach
  • Tworzy model obiektu pliku pomocy, który można manipulować w pamięci
  • Udostępnia polecenia cmdlet, które można połączyć w łańcuch w celu wykonywania złożonych operacji
  • Definiuje nowy schemat języka Markdown zawierający wszystkie elementy potrzebne do Get-Help, oraz informacje, które były wcześniej niedostępne.
  • Zapewnij automatyczną konwersję istniejącego języka Markdown (przy użyciu starego schematu) na nowe obiekty, umożliwiając eksportowanie do nowych języków Markdown, YAML lub MAML.
• platyPS v0.14.2 to oryginalna implementacja PlatyPS. Ta wersja nie jest już obsługiwana.

Korzyści z używania PlatyPS

Przed PlatyPS, pliki pomocy były pisane ręcznie z ograniczoną pomocą istniejących narzędzi i edytorów. PlatyPS upraszcza ten proces, umożliwiając zapisywanie plików pomocy w języku Markdown, a następnie konwertowanie ich na MAML.

Język Markdown jest łatwy do nauczenia, szeroko stosowany w społeczności open source i obsługiwany przez wiele edytorów, w tym Visual Studio Code. Markdown można również łatwo przekonwertować na inne formaty, takie jak HTML i PDF. Za pomocą tych plików Markdown można tworzyć pliki pomocy MAML i tworzyć strony HTML dla witryny internetowej.

Zacznij korzystać z PlatyPS

Przed rozpoczęciem pracy z PlatyPS należy zapoznać się z typami pomocy obsługiwanej przez program PowerShell. Aby uzyskać więcej informacji, zobacz Typy pomocy w programie PowerShell.

Tworzenie plików pomocy za pomocą PlatyPS to proces składający się z czterech kroków:

1. Utwórz nowe lub zaktualizuj istniejące pliki pomocy języka Markdown.
2. Edytuj pliki pomocy języka Markdown , aby dodać opisy i przykłady.
3. Przetestuj pliki pomocy języka Markdown , aby upewnić się, że są one poprawnie renderowane.
4. Przekonwertuj i opublikuj pliki pomocy.