New-Document

SYNOPSIS

Create new markdown docs in the docs folder.

SYNTAX

New-Document [[-Title] <String>] [-Type <String>] [-Chapter <String>] [<CommonParameters>]

DESCRIPTION

Scaffold new markdown documents in the project with headers and subchapters.

EXAMPLES

EXAMPLE 1

New-Document -Type Narrative -Title "Using Helper Functions" -Chapter "Workflow"

This example shows the most explicit use of the command to create a markdown document at `./docs/narrative/Workflow/using-helper-functions.md`

EXAMPLE 2

New-Document -Type Concept -Title "Writing Helper Functions" -Chapter "Contributing/Code"

This example shows using the command to create a markdown document in subchapters at `./docs/concept/Contributing/Code/writing-helper-functions.md`

EXAMPLE 3

New-Document -Title "Concept/Contributing/Code/Writing Helper Functions"

In this example we use the shorthand specification in the title, including the type of documentation and chapters prepended to the title.

EXAMPLE 4

'Concept/Contributing/Code/Writing Helper Functions','Narrative/Workflow/Using Helper Functions" `

| New-Document

Here we show that you can pass multiple titles in the shorthand format to the command over the pipeline.

PARAMETERS

-Chapter

Arbitrary subchapters for the document to reside within, separated by a forward slash.

Type: String
Parameter Sets: (All)
Aliases:

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

-Title

The title of the document to be created. Optionally, you can specify the title to include both the type and chapters, such as 'Concept/Chapter/Subchapter/My Document Title'

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Type

The type of documentation to be created, usually concept, narrative, or reference. Determines which folder inside the docs directory to place the subchapters and document.

Type: String
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).

INPUTS

OUTPUTS

NOTES

results matching ""

    No results matching ""