Giter VIP home page Giter VIP logo

xmlcommentmarkdowngenerator's Introduction

XmlCommentMarkDownGenerator

Usage: PxtlCa.XmlCommentMarkDownGenerator -i InputFileName.xml -o OutputFileName.md

-i, --inputfile Input xml file to read.

--cin Read input from console instead of file.

-o, --outputfile Output md file to write.

--cout Write output to console instead of file.

--help Display this help screen.

Execute PxtlCa.XmlCommentMarkDownGenerator.exe --help for usage if the above is out-of-date.

Generates Markdown from VS XML documentation file. Forked from https://gist.github.com/lontivero/593fc51f1208555112e0

Can be used as a stand-alone Markdown command-line tool, but is also available as a NuGet package.

https://www.nuget.org/packages/PxtlCa.XmlCommentMarkDownGenerator

When used as a nuget package, it will add a target to your project to automatically convert generated xml into markdown file stored in Docs at the solution level (peer to the project folder).

(note: the above nuget target was broken after 0.1.5977.1837 because I forgot to commit the nuspec line that does it. Oops. Fixed in 0.2.6130.564)

You must have XML documentation output enabled for your project in both debug and release configurations or it will warn that it can't find the file.

xmlcommentmarkdowngenerator's People

Contributors

ornatwork avatar pxtl avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.