Skip to content

Commit 4d29946

Browse files
authored
Main contents updates (#65)
1 parent b7a7c03 commit 4d29946

3 files changed

Lines changed: 5 additions & 3 deletions

File tree

.ps-docs/Conventions.Doc.ps1

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Export-PSDocumentConvention 'AddMeta' {
2222
$metadata = GetTemplateMetadata -Path $PSDocs.TargetObject;
2323
$Document.Metadata['title'] = $version;
2424
$Document.Metadata['parent'] = $metadata.name;
25+
$Document.Metadata['grand_parent'] = 'Templates'
2526
$Document.Metadata['description'] = $metadata.description;
2627
$Document.Metadata['layout'] = 'template';
2728

_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ exclude:
4141
- tests/
4242
- .devcontainer/
4343
- docs/concepts/
44-
- docs/cmdlets/
44+
- docs/commands/
4545
- docs/release.md
4646

4747
# Build settings

index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
layout: home
66
title: Home
77
nav_order: 1
8-
permalink: /PSDocs.Azure/
8+
permalink: /
99
---
1010

1111
# Git it done
@@ -90,7 +90,8 @@ PSDocs supports the following metadata:
9090
Field | Scope | Type | Description
9191
----- | ----- | ---- | -----------
9292
`name` | Template | `string` | Used for markdown page title.
93-
`description` | Template | `string` | Used as the top description for the markdown page.
93+
`summary` | Template | `string` | Used as a short description for the markdown page.
94+
`description` | Template | `string` | Used as a detailed description for the markdown page.
9495
`description` | Parameter | `string` | Used as the description for the parameter.
9596
`example` | Parameter | `string`, `boolean`, `object`, or `array` | An example use of the parameter. The example is included in the JSON snippet. If an example is not included the default value is used instead.
9697
`ignore` | Parameter | `boolean` | When `true` the parameter is not included in the JSON snippet.

0 commit comments

Comments
 (0)