Skip to content
forked from dotnet/docfx

Static site generator for .NET API documentation.

License

Notifications You must be signed in to change notification settings

turrisxyz/docfx

Repository files navigation

#Generate your API documentation with DocFX

Appveyor

##What is it? DocFX makes it extremely easy to generate your developer hub, complete with API reference, landing page, and how-to. There are currently two versions of the tool:

  • Windows specific IDE version which uses .NET Framework and works with VS 2015 community
  • Cross platform console version which uses .NET Core and DNX

We currently support C# and VB projects.

##How do I get started? Please refer to Getting Started to play with docfx!

##What's included?

File/Folder Description
LICENSE Project license information
README.md Introduction to the project
CONTRIBUTING.md Contribution guidelines to how to contribute to the repo
Documentation Documentation project using docfx to produce the documentation site
src Source code for docfx
test Test cases for docfx using xunit test framework
tools Source code for tools used in code build and deployment

##How to Contribute Check out the contributing page to see the best places to log issues and start discussions.

##License DocFX is licensed under the MIT license.

About

Static site generator for .NET API documentation.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 94.2%
  • F# 2.3%
  • JavaScript 1.7%
  • CSS 0.9%
  • PowerShell 0.7%
  • XSLT 0.1%
  • Other 0.1%