DocFX Example Output

.manifest

{"Vsxmd":"Vsxmd.yml","Vsxmd.Converter":"Vsxmd.Converter.yml","Vsxmd.Converter.#ctor(XDocument)":"Vsxmd.Converter.yml","Vsxmd.Converter.ToMarkdown(XDocument)":"Vsxmd.Converter.yml","Vsxmd.Converter.ToMarkdown":"Vsxmd.Converter.yml","Vsxmd.IConverter":"Vsxmd.IConverter.yml","Vsxmd.IConverter.ToMarkdown":"Vsxmd.IConverter.yml"}

Vsxmd.model.md

Model

{
  "uid": "Vsxmd",
  "id": "Vsxmd",
  "children": [
    {
      "uid": "Vsxmd.Converter",
      "id": "Vsxmd_Converter",
      "isExternal": false,
      "name": [
        {
          "lang": "csharp",
          "value": "Converter"
        },
        {
          "lang": "vb",
          "value": "Converter"
        }
      ],
      "fullName": [
        {
          "lang": "csharp",
          "value": "Vsxmd.Converter"
        },
        {
          "lang": "vb",
          "value": "Vsxmd.Converter"
        }
      ],
      "specName": [
        {
          "lang": "csharp",
          "value": "<xref href=\"Vsxmd.Converter\" fullName=\"Vsxmd.Converter\" name=\"Converter\"/>"
        },
        {
          "lang": "vb",
          "value": "<xref href=\"Vsxmd.Converter\" fullName=\"Vsxmd.Converter\" name=\"Converter\"/>"
        }
      ],
      "type": "class",
      "syntax": {
        "content": [
          {
            "lang": "csharp",
            "value": "public class Converter : object, IConverter"
          },
          {
            "lang": "vb",
            "value": "Public Class Converter\n    Inherits Object\n    Implements IConverter"
          }
        ]
      },
      "level": 0
    },
    {
      "uid": "Vsxmd.IConverter",
      "id": "Vsxmd_IConverter",
      "parent": "Vsxmd",
      "isExternal": false,
      "name": [
        {
          "lang": "csharp",
          "value": "IConverter"
        },
        {
          "lang": "vb",
          "value": "IConverter"
        }
      ],
      "fullName": [
        {
          "lang": "csharp",
          "value": "Vsxmd.IConverter"
        },
        {
          "lang": "vb",
          "value": "Vsxmd.IConverter"
        }
      ],
      "specName": [
        {
          "lang": "csharp",
          "value": "<xref href=\"Vsxmd.IConverter\" fullName=\"Vsxmd.IConverter\" name=\"IConverter\"/>"
        },
        {
          "lang": "vb",
          "value": "<xref href=\"Vsxmd.IConverter\" fullName=\"Vsxmd.IConverter\" name=\"IConverter\"/>"
        }
      ],
      "type": "interface",
      "summary": "<p>Converter for XML docuement to Markdown syntax conversion.</p>\n",
      "syntax": {
        "content": [
          {
            "lang": "csharp",
            "value": "public interface IConverter"
          },
          {
            "lang": "vb",
            "value": "Public Interface IConverter"
          }
        ]
      },
      "level": 0
    }
  ],
  "langs": [
    "csharp",
    "vb"
  ],
  "name": [
    {
      "lang": "csharp",
      "value": "Vsxmd"
    },
    {
      "lang": "vb",
      "value": "Vsxmd"
    }
  ],
  "fullName": [
    {
      "lang": "csharp",
      "value": "Vsxmd"
    },
    {
      "lang": "vb",
      "value": "Vsxmd"
    }
  ],
  "type": "namespace",
  "assemblies": [
    "Vsxmd"
  ],
  "level": 0,
  "_docfxVersion": "1.6.1.0",
  "newFileRepository": {
    "path": "Vsxmd\\apispec",
    "branch": "update-deps",
    "repo": "[email protected]:lijunle/Vsxmd.git"
  }
}

Attrs

{
  "_lang": "csharp",
  "_tocPath": "api/toc.json",
  "_rel": "../",
  "_path": "api/Vsxmd.html",
  "_tocRel": "toc.json"
}

Global

{
  "classesInSubtitle": "Classes",
  "structsInSubtitle": "Structs",
  "interfacesInSubtitle": "Interfaces",
  "enumsInSubtitle": "Enums",
  "delegatesInSubtitle": "Delegates",
  "constructorsInSubtitle": "Constructors",
  "fieldsInSubtitle": "Fields",
  "propertiesInSubtitle": "Properties",
  "methodsInSubtitle": "Methods",
  "eventsInSubtitle": "Events",
  "operatorsInSubtitle": "Operators",
  "contributors": "Contributors",
  "lastUpdated": "Last Updated"
}

Vsxmd.yml

items:
- uid: Vsxmd
  id: Vsxmd
  children:
  - Vsxmd.Converter
  - Vsxmd.IConverter
  langs:
  - csharp
  - vb
  name: Vsxmd
  fullName: Vsxmd
  type: Namespace
  assemblies:
  - Vsxmd
references:
- uid: Vsxmd.Converter
  isExternal: false
  name: Converter
  fullName: Vsxmd.Converter
- uid: Vsxmd.IConverter
  parent: Vsxmd
  isExternal: false
  name: IConverter
  fullName: Vsxmd.IConverter
- uid: Vsxmd
  isExternal: false
  name: Vsxmd
  fullName: Vsxmd