<commit_before># Generate your API documentation with *DocFX*

[![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)

|            | Build Status  |  Package   |  Chocolatey |
| ---------- | ------------- | ---------- | ----------- |
| **master** |[![masterstatus](https://img.shields.io/teamcity/http/docfx-ci-0.cloudapp.net/s/DocfxCiWithScripts_DocfxCiForMasterBranch.svg?label=master)](http://docfx-ci-0.cloudapp.net/viewType.html?buildTypeId=DocfxCiWithScripts_DocfxCiForMasterBranch) |[![NuGet](https://img.shields.io/nuget/v/docfx.svg)](http://www.nuget.org/packages/docfx/) |[![Chocolatey](https://img.shields.io/chocolatey/v/docfx.svg)](https://chocolatey.org/packages/docfx)
|  **dev**   |[![devstatus](https://img.shields.io/teamcity/http/docfx-ci-0.cloudapp.net/s/DocfxCiWithScripts_DocfxCiForDevBranch.svg?label=dev)](http://docfx-ci-0.cloudapp.net/viewType.html?buildTypeId=DocfxCiWithScripts_DocfxCiForDevBranch) |[![MyGet](https://img.shields.io/myget/docfx-dev/v/docfx.svg?label=myget)](https://www.myget.org/feed/Packages/docfx-dev)

## 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](https://www.microsoft.com/en-us/download/details.aspx?id=48159)
2. [.NET Core 1.0.0 SDK 1.0.0-preview2-003121](https://go.microsoft.com/fwlink/?LinkID=809122)
3. [Node.js](https://nodejs.org)

#### 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.
  - need [Visual Studio 2015 Update 3.3 or later](https://docs.microsoft.com/en-us/dotnet/articles/core/windows-prerequisites#visual-studio)
  - need [.NET Core Tools for Visual Studio 2015](https://docs.microsoft.com/en-us/dotnet/articles/core/windows-prerequisites#net-core-tools-for-visual-studio-2015)

> Possible build issues
  1. *Test failure with message `\r\n` not equal to `\n` for Windows*<commit_msg>Add x86 version of .NET Core SDK<commit_after># Generate your API documentation with *DocFX*

[![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)

|            | Build Status  |  Package   |  Chocolatey |
| ---------- | ------------- | ---------- | ----------- |
| **master** |[![masterstatus](https://img.shields.io/teamcity/http/docfx-ci-0.cloudapp.net/s/DocfxCiWithScripts_DocfxCiForMasterBranch.svg?label=master)](http://docfx-ci-0.cloudapp.net/viewType.html?buildTypeId=DocfxCiWithScripts_DocfxCiForMasterBranch) |[![NuGet](https://img.shields.io/nuget/v/docfx.svg)](http://www.nuget.org/packages/docfx/) |[![Chocolatey](https://img.shields.io/chocolatey/v/docfx.svg)](https://chocolatey.org/packages/docfx)
|  **dev**   |[![devstatus](https://img.shields.io/teamcity/http/docfx-ci-0.cloudapp.net/s/DocfxCiWithScripts_DocfxCiForDevBranch.svg?label=dev)](http://docfx-ci-0.cloudapp.net/viewType.html?buildTypeId=DocfxCiWithScripts_DocfxCiForDevBranch) |[![MyGet](https://img.shields.io/myget/docfx-dev/v/docfx.svg?label=myget)](https://www.myget.org/feed/Packages/docfx-dev)

## 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](https://www.microsoft.com/en-us/download/details.aspx?id=48159)
2. .NET Core 1.0.0 SDK 1.0.0-preview2-003121 [x86](https://go.microsoft.com/fwlink/?LinkID=809123) | [x64](https://go.microsoft.com/fwlink/?LinkID=809122)
3. [Node.js](https://nodejs.org)

#### 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.
  - need [Visual Studio 2015 Update 3.3 or later](https://docs.microsoft.com/en-us/dotnet/articles/core/windows-prerequisites#visual-studio)
  - need [.NET Core Tools for Visual Studio 2015](https://docs.microsoft.com/en-us/dotnet/articles/core/windows-prerequisites#net-core-tools-for-visual-studio-2015)

> Possible build issues
  1. *Test failure with message `\r\n` not equal to `\n` for Windows*
{'fraction_non_alphanumeric': 0.18840579710144928, 'fraction_numerical': 0.026465028355387523, 'mean_word_length': 4.492502883506344, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 35, 'lorem ipsum': 0, 'www.': 6, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3328066', 'n_tokens_mistral': 1881, 'n_tokens_neox': 1724, 'n_words': 259}