https://github.com/charlesdevandiere/xmldoc2md

Tool to generate markdown from C# XML documentation
https://github.com/charlesdevandiere/xmldoc2md

documentation documentation-generator dotnet markdown

Last synced: 8 days ago
JSON representation

Tool to generate markdown from C# XML documentation

• Host: GitHub
• URL: https://github.com/charlesdevandiere/xmldoc2md
• Owner: charlesdevandiere
• License: mit
• Created: 2019-11-18T11:57:32.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-07-25T07:22:45.000Z (7 months ago)
• Last Synced: 2025-02-06T08:02:56.683Z (8 days ago)
• Topics: documentation, documentation-generator, dotnet, markdown
• Language: C#
• Homepage: https://charlesdevandiere.github.io/xmldoc2md/
• Size: 66.4 KB
• Stars: 50
• Watchers: 3
• Forks: 19
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# XMLDoc2Markdown

Tool to generate markdown from C# XML documentation.

[![Build Status](https://dev.azure.com/charlesdevandiere/charlesdevandiere/_apis/build/status/charlesdevandiere.xmldoc2md?branchName=master)](https://dev.azure.com/charlesdevandiere/charlesdevandiere/_build/latest?definitionId=2&branchName=master)

[![Nuget](https://img.shields.io/nuget/v/XMLDoc2Markdown.svg?color=blue&logo=nuget)](https://www.nuget.org/packages/XMLDoc2Markdown)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=charlesdevandiere_xmldoc2md&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=charlesdevandiere_xmldoc2md)

## How to use

### Install tool

```shell

dotnet tool install -g XMLDoc2Markdown

```

### Generate documentation

```shell

dotnet xmldoc2md  [options]

```

| Argument | Description |

|---|---|

| `` | DLL source path |

| Option | Description |

|---|---|

| `-o, --output ` | Output directory |

| `--index-page-name ` | Name of the index page [default: index] |

| `--examples-path ` | Path to the code examples to insert in the documentation |

| `--github-pages` | Remove '.md' extension from links for GitHub Pages |

| `--gitlab-wiki` | Remove '.md' extension and './' prefix from links for gitlab wikis |

| `--back-button` | Add a back button on each page |

| `--member-accessibility-level ` | Minimum accessibility level of members to be documented. [default: protected] |

| `--structure ` | Documentation structure. [default: flat] |

| `--version` | Show version information |

| `-?, -h, --help` | Show help and usage information |

#### Example

```shell

dotnet xmldoc2md Sample.dll --output docs --github-pages --back-button

```

See complete documentation [here](https://charlesdevandiere.github.io/xmldoc2md/).