# docfx

**Repository Path**: cuixingxing/docfx

## Basic Information

- **Project Name**: docfx
- **Description**: Tools for building and publishing API documentation for .NET projects
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-02-23
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Generate your API documentation with *DocFX*

[![devstatus](https://docfx.visualstudio.com/docfx/_apis/build/status/docfx-gated-checkin-CI)](https://docfx.visualstudio.com/docfx/_build/latest?definitionId=2)
[![Join the chat at https://gitter.im/dotnet/docfx](https://badges.gitter.im/dotnet/docfx.svg)](https://gitter.im/dotnet/docfx?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Github All Releases](https://img.shields.io/github/downloads/dotnet/docfx/total.svg?maxAge=600)](https://github.com/dotnet/docfx/releases/latest)
[![Twitter Follow](https://img.shields.io/twitter/follow/docfxmsft.svg?style=social&label=Follow)](https://twitter.com/docfxmsft)

## What's it

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

## What's next

Check out the road map of DocFX [here](Roadmap.md). For more information on DocFX v3, please visit the [v3 working branch](https://github.com/dotnet/docfx/tree/v3).

## Quick Start

```
choco install docfx
docfx init -q
docfx docfx_project\docfx.json --serve
```

For more information, please refer to [Getting Started](http://dotnet.github.io/docfx/tutorial/docfx_getting_started.html).

## How to Contribute

For new comers, you can start with issues with **[`help-wanted`](https://github.com/dotnet/docfx/labels/help-wanted)**. Check out the [contributing](.github/CONTRIBUTING.md) 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](http://contributor-covenant.org/) to clarify expected behavior in our community.
For more information see the [.NET Foundation Code of Conduct](http://www.dotnetfoundation.org/code-of-conduct).

## License

*DocFX* is licensed under the [MIT license](LICENSE).

### .NET Foundation

*DocFX* is supported by the [.NET Foundation](http://www.dotnetfoundation.org).

## DocFX Project

`dev` is the default branch accepting Pull Requests. It releases a package daily. `master` branch is the release branch.

### How to build from source code

#### Prerequisites

1. [Visual Studio 2017](https://www.visualstudio.com/vs/) with *.NET Core cross-platform development* toolset
2. [Node.js](https://nodejs.org)

#### Steps

- Option 1: Run `build.cmd` under *DocFX* code repo.
- Option 2: Open `docfx.sln` under *DocFX* code repo in Visual Studio and build docfx.sln.

### Build Status

| master | dev
| - | -
| [![Build Status](https://ceapex.visualstudio.com/Engineering/_apis/build/status/Docs.Build/docfx-v2-master-release?branchName=master)](https://ceapex.visualstudio.com/Engineering/_build/latest?definitionId=1503&branchName=master) | [![Build Status](https://ceapex.visualstudio.com/Engineering/_apis/build/status/Docs.Build/docfx-v2-dev-release?branchName=dev)](https://ceapex.visualstudio.com/Engineering/_build/latest?definitionId=1743&branchName=dev)

### Packages

| Chocolatey | Nuget | Nightly Build
| - | - | -
| [![Chocolatey](https://img.shields.io/chocolatey/v/docfx.svg)](https://chocolatey.org/packages/docfx) | [![NuGet](https://img.shields.io/nuget/v/docfx.svg)](http://www.nuget.org/packages/docfx/) | [![MyGet](https://img.shields.io/myget/docfx-dev/v/docfx.svg?label=myget)](https://www.myget.org/feed/Packages/docfx-dev)

### Running Status

| Windows with VS2017 | Ubuntu Linux with Mono
| ------------- |----------
| [![VS](https://docascode.visualstudio.com/_apis/public/build/definitions/c8f1f4cb-74cb-4c89-a2db-6c3438796b0a/2/badge)](https://docascode.visualstudio.com/docfx/_build/index?context=mine&path=%5C&definitionId=2&_a=completed)|[![Ubuntu](https://travis-ci.org/docascode/docfx.test.svg?branch=master)](https://travis-ci.org/docascode/docfx.test)