Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Multiple changes/adaptions #504

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions docs/Get-HelpPreview.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,3 @@ You can pipe an array of paths to this cmdlet.
### Help Object
This cmdlet returns a **Help** object, which is the same output as **Get-Help**.

## NOTES

## RELATED LINKS
3 changes: 0 additions & 3 deletions docs/Get-MarkdownMetadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,3 @@ You can pipe an array of paths to this cmdlet.
The cmdlet returns a **Dictionary\[String, String\]** object.
The dictionary contains key-value pairs found in the markdown metadata block.

## NOTES

## RELATED LINKS
20 changes: 16 additions & 4 deletions docs/Merge-MarkdownHelp.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Merge multiple markdown versions of the same cmdlet into a single markdown file.

```
Merge-MarkdownHelp [-Path] <String[]> [-OutputPath] <String> [-Encoding <Encoding>] [-ExplicitApplicableIfAll]
[-Force] [[-MergeMarker] <String>] [<CommonParameters>]
[-Force] [-NoInputOutputFormatting] [[-MergeMarker] <String>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -141,6 +141,21 @@ Accept pipeline input: True (ByValue)
Accept wildcard characters: True
```

### -NoInputOutputFormatting
Will prevent Input/Output comments from being formatted. This might be needed because Microsoft gives us no way to actually set the values in Input/Output correct (type, description) in a PS function header, but will put everything written down there into the "type" property, so all text would be formatted bold in that case. For the Input/Output texts in a PS function header to be written without bold formatting (as is) this switch needs to be provided.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

Expand All @@ -152,6 +167,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### System.IO.FileInfo[]

## NOTES

## RELATED LINKS
2 changes: 0 additions & 2 deletions docs/New-ExternalHelp.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,8 +232,6 @@ You can pipe an array of paths to this cmdlet.
### System.IO.FileInfo[]
This cmdlet returns a **FileInfo[]** object for created files.

## NOTES

## RELATED LINKS

[PowerShell V2 External MAML Help](https://blogs.msdn.microsoft.com/powershell/2008/12/24/powershell-v2-external-maml-help/)
Expand Down
2 changes: 0 additions & 2 deletions docs/New-ExternalHelpCab.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,6 @@ You cannot pipe values to this cmdlet.
This cmdlet does not generate output.
The cmldet saves its results in the output folder that the *OutputPath* parameter specifies.

## NOTES

## RELATED LINKS

[New-ExternalHelp](New-ExternalHelp.md)
Expand Down
91 changes: 84 additions & 7 deletions docs/New-MarkdownHelp.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,27 @@ Creates help in markdown format.
```
New-MarkdownHelp -Module <String[]> [-Session <PSSession>] [-Force] [-AlphabeticParamsOrder]
[-Metadata <Hashtable>] -OutputFolder <String> [-NoMetadata] [-UseFullTypeName] [-Encoding <Encoding>]
[-WithModulePage] [-ModulePagePath <String>] [-Locale <String>] [-HelpVersion <String>] [-FwLink <String>]
[-ExcludeDontShow] [<CommonParameters>]
[-SinglePage] [-WithModulePage] [-ModulePagePath <String>] [-Locale <String>] [-HelpVersion <String>]
[-FwLink <String>] [-ExcludeDontShow] [-NoInputOutputFormatting] [-SkipEmptyFields] [-CreateTableOfContent]
[-WithModuleMetaData] [<CommonParameters>]
```

### FromCommand
```
New-MarkdownHelp -Command <String[]> [-Session <PSSession>] [-Force] [-AlphabeticParamsOrder]
[-Metadata <Hashtable>] [-OnlineVersionUrl <String>] -OutputFolder <String> [-NoMetadata] [-UseFullTypeName]
[-Encoding <Encoding>] [-ExcludeDontShow] [<CommonParameters>]
[-Encoding <Encoding>] [-ExcludeDontShow] [-NoInputOutputFormatting] [-SkipEmptyFields]
[-CreateTableOfContent] [-WithModuleMetaData] [<CommonParameters>]
```

### FromMaml
```
New-MarkdownHelp -MamlFile <String[]> [-ConvertNotesToList] [-ConvertDoubleDashLists] [-Force]
[-AlphabeticParamsOrder] [-Metadata <Hashtable>] -OutputFolder <String> [-NoMetadata] [-UseFullTypeName]
[-Encoding <Encoding>] [-WithModulePage] [-ModulePagePath <String>] [-Locale <String>] [-HelpVersion <String>]
[-FwLink <String>] [-ModuleName <String>] [-ModuleGuid <String>] [-ExcludeDontShow] [<CommonParameters>]
[-Encoding <Encoding>] [-SinglePage] [-WithModulePage] [-ModulePagePath <String>] [-Locale <String>]
[-HelpVersion <String>] [-FwLink <String>] [-ModuleName <String>] [-ModuleGuid <String>] [-ExcludeDontShow]
[-NoInputOutputFormatting] [-SkipEmptyFields] [-CreateTableOfContent] [-WithModuleMetaData]
[<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -490,6 +494,81 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -CreateTableOfContent
Will create an additional table of content in the single- or module-landing-page.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -NoInputOutputFormatting
Will prevent Input/Output comments from being formatted. This might be needed because Microsoft gives us no way to actually set the values in Input/Output correct (type, description) in a PS function header, but will put everything written down there into the "type" property, so all text would be formatted bold in that case. For the Input/Output texts in a PS function header to be written without bold formatting (as is) this switch needs to be provided.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -SinglePage
Will create a single markdown file with the description of the module and each cmdlet/function, instead of writing a new markdown file for each cmdlet/function.

```yaml
Type: SwitchParameter
Parameter Sets: FromModule, FromMaml
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -SkipEmptyFields
Will omit example texts for empty fields which were not provided/found in the documentation and will instead just skip empty sections (example: no "Notes" section if no "Notes" were provided).

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -WithModuleMetaData
Will add a section "Module Metadata" filled with the following data (as far as that data exists): Module version, Module GUID, Author, Company, Copyright, Tags, License Uri, Project Uri.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

Expand All @@ -504,8 +583,6 @@ These are the modules from which this cmdlet creates help markdown.
### System.IO.FileInfo[]
This cmdlet returns a **FileInfo[]** object for created files.

## NOTES

## RELATED LINKS

[Character Encoding in the .NET Framework](https://msdn.microsoft.com/en-us/library/ms404377.aspx)
Expand Down
3 changes: 0 additions & 3 deletions docs/New-YamlHelp.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,3 @@ You can pipe an array of paths to this cmdlet.
### System.IO.FileInfo[]
This cmdlet returns a **FileInfo[]** object for created files.

## NOTES

## RELATED LINKS
32 changes: 31 additions & 1 deletion docs/Update-MarkdownHelp.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Update PlatyPS markdown help files.
```
Update-MarkdownHelp [-Path] <String[]> [[-Encoding] <Encoding>] [[-LogPath] <String>] [-LogAppend]
[-AlphabeticParamsOrder] [-UseFullTypeName] [-UpdateInputOutput] [-Force] [-Session <PSSession>]
[-ExcludeDontShow] [<CommonParameters>]
[-ExcludeDontShow] [-NoInputOutputFormatting] [-SkipEmptyFields] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -232,6 +232,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -NoInputOutputFormatting
Will prevent Input/Output comments from being formatted. This might be needed because Microsoft gives us no way to actually set the values in Input/Output correct (type, description) in a PS function header, but will put everything written down there into the "type" property, so all text would be formatted bold in that case. For the Input/Output texts in a PS function header to be written without bold formatting (as is) this switch needs to be provided.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -SkipEmptyFields
Will omit example texts for empty fields which were not provided/found in the documentation and will instead just skip empty sections (example: no "Notes" section if no "Notes" were provided).

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

Expand Down
18 changes: 17 additions & 1 deletion docs/Update-MarkdownHelpModule.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ Update all files in a markdown help module folder.
```
Update-MarkdownHelpModule [-Path] <String[]> [[-Encoding] <Encoding>] [-RefreshModulePage]
[-ModulePagePath <String>] [[-LogPath] <String>] [-LogAppend] [-AlphabeticParamsOrder] [-UseFullTypeName]
[-UpdateInputOutput] [-Force] [-Session <PSSession>] [-ExcludeDontShow] [<CommonParameters>]
[-UpdateInputOutput] [-Force] [-Session <PSSession>] [-ExcludeDontShow] [-SkipEmptyFields]
[<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -239,6 +240,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -SkipEmptyFields
Will omit example texts for empty fields which were not provided/found in the documentation and will instead just skip empty sections (example: no "Notes" section if no "Notes" were provided).

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

Expand Down
Loading