Redigera Markdown-hjälpfiler

PlatyPS skapar Markdown-mallfiler som har en specifik struktur. Det är viktigt att behålla denna struktur så att PlatyPS kan uppdatera och konvertera innehållet till andra format på rätt sätt. Strukturen består av en serie avsnitt som definieras av rubrikerna H1, H2 och H3. Varje avsnitt har ett specifikt syfte och formatkrav. När du redigerar filerna måste du se till att du följer dessa krav, inte ändrar ordningen på avsnitten, inte tar bort obligatoriska avsnitt och inte lägger till nya avsnitt.

Struktur för Markdown-fil

Varje Markdown-fil som genereras av PlatyPS har följande struktur:

---
YAML metadata
---
H1: Cmdlet name
H2: SYNOPSIS
H2: SYNTAX
H2: ALIASES - optional header that can be removed if there are no aliases
H2: DESCRIPTION
H2: EXAMPLES
H3: Example title - at least one example is required
H2: PARAMETERS
H3: -ParameterName - zero or more parameters
H2: INPUTS
H3: TypeName - zero or more input types
H2: OUTPUTS
H3: TypeName - zero or more output types
H2: NOTES - Header required but section can be empty
H2: RELATED LINKS - Header required but section can be empty

Alla avsnitt är obligatoriska utom där det anges som valfritt. Ordningen på avsnitten måste upprätthållas. H2-rubrikerna måste vara i versaler.

Detaljer om avsnittet

I följande innehåll beskrivs formateringskraven för Markdown-kommandot för varje avsnitt i filen.

YAML-frontmateria

Avsnittet YAML-frontmatter överst i filen innehåller metadata om cmdleten. Förtexten avgränsas av linjer som innehåller tre bindestreck (---). I följande exempel visas YAML-fronten som genereras automatiskt av PlatyPS.

---
document type: cmdlet
external help file: WidgetModule-Help.xml
HelpUri: ''
Locale: en-US
Module Name: WidgetModule
ms.date: 10/09/2025
PlatyPS schema version: 2024-05-01
title: Get-Widget
---

I följande tabell beskrivs de metadataegenskaper som krävs.

Det här är minsta metadata som krävs. Du kan lägga till ytterligare metadata efter behov. Det publiceringssystem som du använder för att skapa en webbplats kan till exempel kräva ytterligare metadata.

H1-titel

H1-titeln måste matcha cmdlet-namnet exakt. Exempel:

# Get-Widget

H2 SAMMANFATTNING

Avsnittet SYNOPSIS innehåller en kort beskrivning av cmdleten. Begränsa beskrivningen till en enda mening, helst på en enda rad.

Exempel:

## SYNOPSIS

Gets one or more widgets based on specified criteria.

H2-SYNTAX

Avsnittet SYNTAX innehåller syntaxdiagrammet för varje parameteruppsättning som definierats för cmdleten. Syntaxdiagrammen ska matcha den information som tillhandahålls av kommandot Get-Command -Syntax . Om kommandot har flera parameteruppsättningar finns varje parameteruppsättning i ett separat H3-avsnitt. Titeln på H3-avsnittet är namnet på parameteruppsättningen.

Exempel:

## SYNTAX

### DefaultParameterSet

```
Get-Widget [-Name] <string> [-Color <ConsoleColor>] [-Size <int>] [<CommonParameters>]
```

## DetailedParameterSet

```
Get-Widget [-Name] <string> [-Color <ConsoleColor>] [-Size <int>] [-Detailed] [<CommonParameters>]
```

H2-ALIAS

Avsnittet ALIAS används för att dokumentera alias som definierats för cmdleten. Om det inte finns några alias kan du ta bort det här avsnittet. Det här är det enda valfria avsnittet i filen.

Exempel:

## ALIASES

This cmdlet has the following aliases:

- `gwi`

H2 BESKRIVNING

Avsnittet DESCRIPTION innehåller en detaljerad beskrivning av cmdleten. Beskrivningen kan vara flera stycken lång och bör ge tillräckligt med information för att användaren ska förstå syftet med kommandot. Undvik att ge för mycket detaljer. Du kan ge mer information i avsnitten EXAMPLES, PARAMETERS och NOTES.

H2-EXEMPEL

Avsnittet EXEMPEL innehåller ett eller flera exempel som visar hur du använder cmdleten. Det bör finnas minst ett exempel. Varje exempel finns i ett H3-avsnitt. Titeln på H3-avsnittet bör kortfattat beskriva sammanhanget för exemplet. Till skillnad från den tidigare versionen av PlatyPS finns det inga begränsningar för innehållet i det här avsnittet. Du kan blanda flera kodblock och text. På så sätt kan du ge mer detaljerade förklaringar av exempel och utdata, inklusive exempel som kräver flera kodblock med separata förklaringar.

Exempel:

## EXAMPLES

### Example 1 - Get a widget by name

```powershell
Get-Widget -Name "Widget1"
```

H2-PARAMETRAR

Avsnittet PARAMETERS innehåller beskrivningar av de parametrar som definierats för cmdleten. Om kommandot inte tar några parametrar kan avsnittet vara tomt, men H2-huvudet krävs. Varje parameter dokumenteras i ett eget H3-avsnitt. Titeln på H3-avsnittet är namnet på parametern.

Exempel:

### -Color

Filter the results by the color of the widget.

```yaml
Type: System.ConsoleColor
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
```

PlatyPS genererar automatiskt ett YAML-kodblock som innehåller metadata om parametern. Du måste ange en beskrivning av parametern. Förutom några specifika fält bör du inte ändra innehållet i YAML-kodblocket. Dessa värden för dessa fält fylls i av PlatyPS genom att inspektera cmdleten med hjälp av reflektion. De enda undantagen som kan behöva ändras är:

• DefaultValue - Standardvärdet kan inte upptäckas genom reflektion.
• SupportsWildcards - Det här värdet kan bara upptäckas om kommandoförfattaren har tillämpat attributet på [SupportsWildcards()] parametern. Tyvärr används inte det här attributet ofta, även om jokertecken stöds.

H2-INGÅNGAR

I avsnittet INPUTS beskrivs de typer av objekt som cmdleten accepterar via pipelineindata. Varje typ dokumenteras i ett eget H3-avsnitt. Titeln på H3-avsnittet är namnet på typen. Använd fullständiga typnamn. Innehållet i H3-avsnittet bör identifiera namnet på de parametrar som accepterar den typen av indata. Om cmdleten inte accepterar pipelineindata kan avsnittet vara tomt, men H2-huvudet krävs.

Exempel:

## INPUTS

### System.String

This cmdlet accepts pipeline input for the name of the widget.

H2-UTGÅNGAR

I avsnittet OUTPUTS beskrivs de typer av objekt som cmdleten returnerar. Varje typ dokumenteras i ett eget H3-avsnitt. Titeln på H3-avsnittet är namnet på typen. Använd fullständiga typnamn. Innehållet i H3-avsnittet bör beskriva typen och eventuella viktiga egenskaper. Om cmdleten inte returnerar några objekt kan avsnittet vara tomt, men H2-huvudet krävs.

Exempel:

## OUTPUTS

### Widget

Outputs Widget objects representing the retrieved widgets.

H2 ANMÄRKNINGAR

Avsnittet ANTECKNINGAR innehåller ytterligare information om cmdleten. Avsnittet kan vara tomt, men H2-huvudet är obligatoriskt. Du kan använda det här avsnittet för att dokumentera särskilda överväganden, begränsningar, versionsskillnader och information som inte får plats i andra avsnitt.

H2 RELATERADE LÄNKAR

Avsnittet RELATERADE LÄNKAR innehåller länkar till relaterade ämnen. Avsnittet kan vara tomt, men H2-huvudet är obligatoriskt. Länkarna ska formateras som en punktlista med Markdown-länkar. Det här avsnittet får inte innehålla något annat innehåll.

## RELATED LINKS

- [All about widgets](https://docs.tailspintoys.com/widgets)

Nästa steg

• Testa Markdown-hjälpfilerna