Summary
Metadata keys used by the blog recipe.
- Assembly
- Wyam
.Blog .dll - Namespace
- Wyam
.Blog - Base Types
-
- Object
graph BT
Type-->Base0["Object"]
Type["BlogKeys"]
class Type type-node
Syntax
public static class BlogKeys
Fields
Name | Constant Value | Summary |
---|---|---|
ArchiveExcerpts | ArchiveExcerpts |
Specifies whether the excerpts should be output on the archive page(s)
(if not specified or
false , only the title and description will be displayed).
Note that this also controls displaying excerpts on the tag archive pages.
static
|
ArchivePageSize | ArchivePageSize |
The page size for the archive page (if not specified, no paging will be used).
static
|
AtomPath | AtomPath |
Specifies the path where the blog Atom file will be output.
The default value is
feed.atom . Set to null
to prevent generating an Atom feed.
static
|
CaseInsensitiveTags | CaseInsensitiveTags |
Set to
true to make tag groupings case-insensitive.
static
|
Description | Description |
The description of your blog (usually placed on the home page).
static
|
Excerpt | Excerpt |
An excerpt of the blog post, automatically set for each document
by the recipe.
static
|
GenerateArchive | GenerateArchive |
Specifies whether an archive should be generated (the default is
true ).
static
|
IgnoreFolders | IgnoreFolders |
This should be a string or array of strings with the name(s)
of root-level folders to ignore when scanning for content pages.
Setting this global metadata value is useful when introducing
your own pipelines for files under certain folders and you don't
want the primary content page pipelines to pick them up.
static
|
Image | Image |
The relative path to a page image.
static
|
Include |
IncludeDateInPostPath |
Setting this to
true uses
the year and date in the output path of blog posts.
The default value is false .
static
|
IndexFullPosts | IndexFullPosts |
Specifies whether the full post content should be output on the index page(s)
(if not specified or
false , only the excerpt will be output).
static
|
IndexPageSize | IndexPageSize |
The page size for the index page(s) (if not specified, a default of 3 will be used).
static
|
IndexPaging | IndexPaging |
Specifies whether index pages should be generated (if not specified or
false ,
only the first index page will be generated).
static
|
IndexPath | IndexPath |
Specifies the output path of the generated index. By default this
is the home page of your site at "index.html". If you change this
it lets you provide an alternate home page for your site while still
generating a list of posts at the specified output location.
static
|
IndexTemplate | IndexTemplate |
Specifies the path of the template file that lists your blog posts
(which is also typically used as the home page by default).
By default this setting is "_Index.cshtml". The file path will be used to
read the index template. If you change it, you are responsible for providing
this file in your input path (for example, by copying the "_Index.cshtml" from
a theme to the specified file name in your input folder).
static
|
Intro | Intro |
A short introduction to your blog (usually placed on the home page
under the description).
static
|
Lead | Lead |
A short description of a particular blog post.
static
|
Markdown |
MarkdownConfiguration |
Set this to control the activated set of Markdown extensions for the
Markdig Markdown renderer. The default value is "advanced+bootstrap".
static
|
Markdown |
MarkdownExtensionTypes |
Set this to add extension Markdown extensions for the Markdig Markdown
renderer. The default value is null;
static
|
Markdown |
MarkdownPrependLinkRoot |
Set to
true to prepend a configured LinkRoot to all root-relative Markdown links.
static
|
MetaRefreshRedirects | MetaRefreshRedirects |
Set to
true (the default value) to generate meta refresh pages
for any redirected documents (as indicated by a RedirectFrom
metadata value in the document).
static
|
NetlifyRedirects | NetlifyRedirects |
Set to
true (the default value is false ) to generate
a Netlify _redirects file from redirected documents
(as indicated by a RedirectFrom metadata value).
static
|
Posts | Posts |
Set by the recipe for tag groups. Contains the set of documents with a given tag.
static
|
PostsPath | PostsPath |
Controls the parent path where blog posts are placed. The default is "posts".
This affects both input and output files (I.e., if you change this your input
files must also be under the same path).
static
|
ProcessIncludes | ProcessIncludes |
Indicates that include statements should be processed using the
Wyam.Core.Modules.IO.Include module.
The default behavior is not to process includes.
static
|
Published | Published |
The date of the post.
static
|
RdfPath | RdfPath |
Specifies the path where the blog RDF file will be output.
The default value is
null which
prevents generating an RDF feed.
static
|
RssPath | RssPath |
Specifies the path where the blog RSS file will be output.
The default value is
feed.rss . Set to null
to prevent generating an RSS feed.
static
|
ShowInNavbar | ShowInNavbar |
Set to
false to hide a particular page from the top-level navigation bar.
static
|
Tag | Tag |
Set by the recipe to the name of the tag for each tag group.
static
|
TagPageSize | TagPageSize |
The page size for tag archive pages (if not specified, no paging will be used).
static
|
Tags | Tags |
The tags for a given post.
static
|
Title | Title |
The title of the blog, post, or page.
static
|
Validate |
ValidateAbsoluteLinks |
Set to
true (the default value is false ) to
validate all absolute links. Note that this may add considerable
time to your generation process.
static
|
ValidateLinksAsError | ValidateLinksAsError |
Set to
true (the default value is false ) to
report errors on link validation failures.
static
|
Validate |
ValidateRelativeLinks |
Set to
true (the default value) to
validate all relative links.
static
|