docfx

docfx copied to clipboard

I'd like to be able to use docfx to generate API ref docs from my already built NuGet packages. The packages already contain the built .NET assemblies and the XML...

danroth27

Suggestion: make docfx to support to be included as a part in a site generated by other tools

4

Make docfx to play well with other tools. I already have a static site generated by my toolset. And I want to include several areas with api doc generated by...

evil-shrike

Use xref target heading instead of first heading as link title

2

**Feature request** xref can link to the middle of a document using #. Documentation says: > Title is extracted from the first heading of the Markdown file. Or you can...

KristianWedberg

Url prettifier

13

Right now, markdown files (articles) are translated to html files which are available via direct link like `https://mydomain.com/articles/article-name.html`. I want to "prettify" it and get an url like `https://mydomain.com/articles/article-name/`. Actually,...

AndreyAkinshin

Search filter

8

**DocFX Version Used**: 2.35.4 **Template used**: default **Steps to Reproduce**: 1. generate with basic options **Expected Behavior**: have ability to apply filter to top search **Actual Behavior**: I don't see...

wayneamurphy

Swagger response sample and schema not displayed

6

**DocFX Version Used**: 2.21.1.1 **Template used**: custom template **Steps to Reproduce**: 1. added **.swagger.json in docfx.json file 2. imported .swagger files 3. ran the service **Expected Behavior**: Swagger file should...

cbenea

exclude files from csproj

5

**DocFX Version Used**: 2.36.2 (nuget) **Template used**: `default` **Steps to Reproduce**: I'm trying to use docfx to generate code from assemblies and a unity project using these assemblies through several...

flonou

Code snippet notation proposal for CSHTML files

1

**DocFX Version Used**: 2.37.0.0 Per [this doc](http://dotnet.github.io/docfx/spec/docfx_flavored_markdown.html?tabs=tabid-1%2Ctabid-a#tag-name-representation-in-code-snippet-source-file), the following syntax is used to denote a snippet in a *.cshtml file: > Start with: `` > End with: `` This syntax...

scottaddie

Use MSBUILD to configure DocFX / Better MSBUILD integration

6

It would be nice to integrate DocFX better into the MSBUILD ecosystem. That would make align DocFX with .NET Core, and make it easier to configure DocFX in big solutions,...

ChristophLindemann

Improve API filter validation

2

`filterConfig.yml` is error prone. We need some validation on it. Consider to add a JSON schema validation. Related: - https://github.com/dotnet/docfx/issues/1948#issuecomment-457828024

superyyrrzz