Class
MarkdownReadmeOptions
OfficeIMO.Markdown
Options for README scaffolding.
Inheritance
- object
- MarkdownReadmeOptions
Usage
Explore 7 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 6
Accepted by parameters 1
- Method MarkdownScaffold.Readme
Constructors
public MarkdownReadmeOptions(string projectName) #Create options for project.
Parameters
- projectName string
Methods
public MarkdownReadmeOptions Badges(Action<MarkdownBadgeBuilder> build) #Adds badges via builder.
Parameters
- build System.Action<OfficeIMO.Markdown.MarkdownBadgeBuilder>
Returns
MarkdownReadmeOptionspublic MarkdownReadmeOptions Description(string description) #Sets the README description paragraph.
Parameters
- description string
Returns
MarkdownReadmeOptionspublic MarkdownReadmeOptions GettingStarted(string installCommand, string codeBlock) #Sets install command and getting-started code snippet.
Parameters
- installCommand string
- codeBlock string
Returns
MarkdownReadmeOptionspublic MarkdownReadmeOptions Links(params ValueTuple<string, string>[] links) #Adds links section entries.
Parameters
- links System.ValueTuple<string, string>[]
Returns
MarkdownReadmeOptionspublic MarkdownReadmeOptions NuGet(string packageId) #Sets the NuGet package id.
Parameters
- packageId string
Returns
MarkdownReadmeOptions