This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.DocFx.
Summary
Constants for metadata keys.
- Assembly
- Cake
.DocFx .dll - Namespace
- Cake
.DocFx - Base Types
-
- Object
graph BT
Type-->Base0["Object"]
Type["DocFxGlobalMetadata"]
class Type type-node
Syntax
public static class DocFxGlobalMetadataFields
| Name | Constant Value | Summary |
|---|---|---|
| AppFaviconPath | _appFaviconPath |
Metadata key for setting the favicon file's path from output root.
If not specified DocFX's favicon will be shown.
Remember to add file to resource.
static
|
| AppFooter | _appFooter |
Metadata key for setting the footer text.
If not specified DocFX's Copyright will be shown.
static
|
| AppLogoPath | _appLogoPath |
Metadata key for setting the logo file's path from output root.
If not specified DocFX's logo will be shown.
Remember to also add file to resource.
static
|
| AppTitle | _appTitle |
Metadata key for setting the title.
The value will be appended to each output page's head title.
static
|
| DisableAffix | _disableAffix |
Metadata key for disabling the affix bar on the right of each page.
static
|
| DisableBreadcrumb | _disableBreadcrumb |
Metadata key for disabling the breadcrumb on the top of each page.
static
|
| DisableContribution | _disableContribution |
Metadata key for disabling the "View Source" and "Improve this Doc" buttons.
static
|
| DisableNavbar | _disableNavbar |
Metadata key for disabling the navigation bar on the top of each page.
static
|
| DisableToc | _disableToc |
Metadata key for disabling table of contents on the left of each page.
static
|
| EnableNewTab | _enableNewTab |
Metadata key for setting indicating whether to open a new tab when clicking an external link.
Internal links always shows within the current tab.
static
|
| EnableSearch | _enableSearch |
Metadata key for showing the search box on the top of each page.
static
|
| GitContribute | _gitContribute |
Metadata key for customizing the "Improve this Doc" URL button for public contributors.
Use repo to specify the contribution repository URL.
Use branch to specify the contribution branch.
Use path to specify the folder for new overwrite files.
If not set, the Git URL and branch of the current Git repository will be used.
static
|
| GitUrlPattern | _gitUrlPattern |
Metadata key for choosing the URL pattern of the generated link for "View Source" and "Improve this Doc".
Supports
github and vso currently.
If not set, DocFX will try speculating the pattern from domain name of the Git URL.
static
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
| To |
string |
Returns the string value or a
Not set> markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|