WiX documentation is compiled into the file WiX.chm as a part of the WiX build process. The source files for help are located in the wix\src\chm directory. The documentation is written in markdown.
The WiX help compiler does the following:
Parses .xsd schema files referenced in chm.helpproj and generates help topics for the attributes and elements that are annotated in the .xsd files.
Compiles all of the markdown files contained in the documents directory into HTML stripping the final file extension (.md).
Each markdown document consists of a metadata header followed by the content of the topic page.
Adding a new topic to WiX.chm requires the following steps:
An example of the metadata header (includes the triple-dash delimiting lines):
--- title: Adding to the WiX Documentation layout: documentation after: votive_development ---
Help topics may contain links to external Web pages, and may also contain relative links to other help topics or attributes or elements defined in one of the .xsd schema files.
To build the new content type
msbuild from the command line in the src\chm directory.
It is not necessary to build the entire toolset to build the documentation, but you must first build the tools\src directory once (using the same build command) before building the chm. To build the tools, you will need to install the Desktop development with C++ workload in Visual Studio, using the Visual Studio Installer.