Giter VIP home page Giter VIP logo

docfx's Introduction

Generate your API documentation with DocFX

Join the chat at https://gitter.im/dotnet/docfx Github All Releases

Build Status Package Chocolatey
master masterstatus NuGet Chocolatey
dev devstatus MyGet

What is it?

DocFX makes it extremely easy to generate your developer hub with API reference, landing page, and how-to.

We currently support C# and VB projects.

How to build?

Prerequisites

  1. Microsoft Build Tools 2015
  2. .NET Core 1.0.0 SDK 1.0.0-preview2-003121
  3. Node.js

Steps

  1. Option 1: Run build.cmd under DocFX code repo.
  2. Option 2: Open All.sln under DocFX code repo in Visual Studio and build All.sln.

Possible build issues

  1. Test failure with message \r\n not equal to \n for Windows Set git config --global core.autocrlf true

How do I play with DocFX?

Please refer to Getting Started.

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 Source for our 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. This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the .NET Foundation Code of Conduct.

License

DocFX is licensed under the MIT license.

.NET Foundation

DocFX is supported by the .NET Foundation.

docfx's People

Contributors

vwxyzh avatar vicancy avatar qinezh avatar superyyrrzz avatar fenxu avatar herohua avatar chenkennt avatar hellosnow avatar ansyral avatar marzinz avatar 928pjy avatar peterennis avatar huachao avatar jsntcy avatar danroth27 avatar duncanma avatar atifaziz avatar pengbian avatar nothrow avatar xen2 avatar terribledev avatar gitter-badger avatar seandebutts avatar ferventcoder avatar reinaldoarrosi avatar pranavkm avatar petermorlion avatar meganbradley avatar mathewsachin avatar martinwoodward avatar

Watchers

James Cloos avatar Hakan 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.