Overview

The Docs recipe is designed to cover many different use cases for documentation sites including any combination of blog, content, and API documentation. The generated site will automatically adapt to the input files and will hide navigation sections and other functionality if those types of files aren't available. For example, if you don't specify code or assemblies for the API section, the generated site will still be great for content pages and/or blog posts.

Key Features

  • Nested documentation content pages.
  • Blog posts with optional category and author.
  • Paged blog archives for posts, categories, authors, and dates.
  • Posts and pages can be in Markdown or Razor.
  • API documentation from source files.
  • API documentation from assemblies (with or without XML documentation file from MSBuild).
  • Support for both namespace documentation and <inheritdoc/> XML comments.
  • Static site searching for API types.
  • Meta-refresh redirects and/or a Netlify redirect file.
  • RSS, Atom, and/or RDF feeds.

Scaffolding

To scaffold the recipe, run:

wyam new -r Docs

This generates a skeleton set of input files that includes a blog post and a content page. You can use this as a starting point for your own site.

Building

To build a site with this recipe, run:

wyam -r Docs

Usage Notes

MSBuild Tools

Depending on the type of projects you're building documentation for and what versions of Visual Studio you have installed (if any), you may need to install the Microsoft Build Tools 2015. Specifically, if you see project loading errors that reference System.Threading.Tasks.Dataflow from your project files when verbose output is turned on you'll need to install the build tools.

Source Files

By default, your source files should be located in a "src" folder either under your "input" folder or alongside your "input" folder. You can also change where the recipe looks for source files from within the configuration file with the SourceFiles setting. Note that this setting doesn't point to a directory, but should rather be a string containing a globbing pattern for each source file:

Settings[DocsKeys.SourceFiles] = @"C:/MySource/**/{!bin,!obj,!packages,!*.Tests,}/**/*.cs";

Blog Post Published Dates

To find the published date for blog posts, the metadata will first be searched for a Published value. If one cannot be found (or it can't be converted to a DateTime) then the filename of the input file for the post will be checked for a date that appears in the beginning of the file name of the format YYYY-MM-DD-.

Namespace Documentation Comments

The XML documentation standard is ambiguous on how you should defined comments for namespaces. Wyam will pick up standard XML documentation comments on any arbitrary namespace usage within your code. Alternatively, you can use a class named NamespaceDoc and place your namespace XML documentation comments on that class. Note that the former will not work if generating documentation from an assembly since the MSBuild XML documentation file does not output XML documentation comments for namespace usages.

Inheriting Documentation and Implicit Inheritance

Normally you have to include a special <inheritdoc/> XML comment to indicate that you want documentation comments from a base class or interface to be inherited. This is fully supported automatically and any use of <inheritdoc/> will be expanded. However, that adds a lot duplication to your codebase. If you would prefer assume <inheritdoc/> for any symbols that don't have their own XML documentation comments, add the following to your configuration file:

Settings[DocsKeys.ImplicitInheritDoc] = true;

Redirects

If migrating your site from another generator, the paths may not match up exactly. This recipe supports multiple styles of redirects. To activate, add RedirectFrom metadata to the front matter of each page that should be the endpoint of a redirection. You can control what gets generated to support redirection with the MetaRefreshRedirects and NetlifyRedirects global metadata values. By default, meta refresh redirects are generated. These are small HTML files that contain a <meta> header tag redirecting the client. They are also supported by Google and other search engines.

The recipe includes the ability to validate both relative (internal) and absolute (external) links. Both features are opt-in given that they add additional time to the generation process. To activate them add Settings[DocsKeys.ValidateRelativeLinks] = true; for relative link validation and/or Settings[DocsKeys.ValidateAbsoluteLinks] = true; for absolute link validation to your configuration file.

By default validation failures output a warning with details on the link, why it failed, and which files it's in. You can switch to outputting errors (which will usually break the build) by using Settings[DocsKeys.ValidateLinksAsError] = true; in your configuration file.

Note that turning on validation for absolute links typically results in a number of falsly reported failures which will need to be checked manually (so it's not recommended to validate absolute links and output errors).

GitHub