- Namespace
- Statiq
.Docs - Base Types
-
- object
graph BT
Type-->Base0["object"]
Type["DocsKeys"]
class Type type-node
Syntax
public static class DocsKeys
Fields
Name | Field Type | Constant Value | Summary |
---|---|---|---|
ApiLayout | string | ApiLayout |
The path to a layout file for use with API documents. Themes can use this
to set a consistent layout that works even when
ApiPath changes.
If undefined, normal layout file searching rules will apply.
static
|
ApiPath | string | ApiPath |
Controls the parent path where API docs are placed. The default is "api".
static
|
AssemblyFiles | string | AssemblyFiles |
Indicates where to locate assemblies for the API documentation. You can specify
one (or more) globbing pattern(s).
static
|
ImplicitInheritDoc | string | ImplicitInheritDoc |
Setting this to
true will assume inheritdoc for all API symbols
that don't provide their own documentation comments.
static
|
Include |
string | IncludeGlobalNamespace |
Controls whether the global namespace is included in your API
documentation.
static
|
Minimum |
string | MinimumStatiqDocsVersion |
Sets a semantic version range of Statiq Docs that must be used.
Particularly useful for themes to set a supported version range.
static
|
OutputApiDocuments | string | OutputApiDocuments |
Controls whether API symbol documents should be output or treated only as data.
The default is
true which outputs pages for each symbol.
static
|
ProjectFiles | string | ProjectFiles |
Indicates where to locate project files for the API documentation.
static
|
SolutionFiles | string | SolutionFiles |
Indicates where to locate solution files for the API documentation.
static
|
SourceFiles | string | SourceFiles |
Indicates where to locate source files for the API documentation.
By default the globbing patterns "src/**/{!.git,!bin,!obj,!packages,!*.Tests,}/**/*.cs"
and "../src/**/{!.git,!bin,!obj,!packages,!*.Tests,}/**/*.cs"
are used which searches for all "*.cs" files at any depth under a "src" folder
but not under "bin", "obj", "packages" or "Tests" folders. You can specify
your own globbing pattern (or more than one globbing pattern) if your source
files are found elsewhere.
static
|