As the name imply, this project lets you easily produce a "good enough" markdown documentation from the xml documentation produced by visual studio from comments.
framework4.5 or netcoreapp1.0
Once referenced in your project, if there is a <DocumentationFile>, markdown pages will be produced next to the xml file on compilation.
Please be advised that existing *.md files in the directory will be deleted.
Should you want the markdown files to be produced in a different directory, you can do so by adding a <DefaultDocumentationFolder> element in your csproj with the desired path.
List of supported balise taken from here
-
<c> -
<code> -
cref attributein<exception>,<see>and<seealso>elements -
<example> -
<exception> -
<include>(nothing to do) -
<list>not yet -
<para>not yet -
<param> -
<paramref> -
<permission>not yet -
<remarks> -
<returns> -
<see> -
<seealso>handled the same as<see> -
<summary> -
<typeparam> -
<typeparamref> -
<value>not yet
List of supported members taken from here
Should you need some extra support feel free to ask or even do it yourself in a pull request.
You can see the result of DefaultDocumentation applied to a project here.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent