Skip to main content

Markdown Support

Facility supports tools for generating GitHub Flavored Markdown from Facility Service Definitions.

Tools​

Generate Markdown for your Facility Service Definition by doing one of the following:

  • Use the Facility Editor. Enter an API definition in the left pane, choose the "Markdown" generator, review the generated files, and click Download.
  • Run the fsdgenmd tool on the command line or in a build script.
  • Use the Facility.CodeGen.Markdown .NET library (NuGet Package) in your own build tool.

fsdgenmd​

fsdgenmd is a command-line tool that generates Markdown for a Facility Service Definition.

Install fsdgenmd as documented from its NuGet package.

fsdgenmd generates multiple Markdown files and supports the standard command-line options as well as the following additional command-line options:

  • --nohttp: Omits HTTP documentation.