Getting Started

To use this library, simply include Docfx.ResultSnippets.dll in your project or grab it from NuGet, and add this to the top of each .cs file that needs it:

using Docfx.ResultSnippets;

Then you can use it in a project like this,

// some return value
const string result = "Some result to save";
// now it can be saved as an example
result.SaveResults();
// we can also add a part to the name
"Some other result".SaveResults(partName: "part2");

Which generates a Markdown file that can be added via the include file like so,

[!INCLUDE[SomeExample](some/path/to/code/__examples__/ClassName.MethodName.{Optional-PartName}.md)]

See SaveResults for more details about the file name format.