Stack Overflow
Stack Overflow

Questions tagged [docfx]

Docfx is a tool, to create documentation from visual studio projects and mixing them with custom articles using markdown. If you meet a bug or have a feature request, please open an issue on GitHub.

Docfx is a tool to create documentation from Visual Studio projects, mixing them with custom articles using markdown: https://dotnet.github.io/docfx/

If you meet a bug or have a feature request, please open an issue: https://github.com/dotnet/docfx/issues

130 questions
14
votes
1 answer

How can I generate documentation for C# that outputs as Markdown for an Azure DevOps Wiki?

I've been using DocFX to generate code documentation for C# and for the most part found a lot of success with it. The articles are flexible and I really like that I can use markdown to maintain them while having them live side by side with the API…
War Gravy
  • 1,543
  • 3
  • 20
  • 32
13
votes
4 answers

PackageReference condition is ignored

In my VS 2017 project I reference docfx.console package and I want it to be used only when certain condition is met. But the package gets used for all builds. Here is a part of my project. I want docfx.console to be used when configuration is…
Bobrovsky
  • 13,789
  • 19
  • 80
  • 130
12
votes
2 answers

How to generate documentation for other projects within solution using DocFx

I am using DocFx to automatically generate documentation in Visual Studio 2015. Per the Getting Started instructions, I added an empty ASP.NET 4 Web Application and used the Nuget Console to install the DocFx build package (e.g. Install-Package…
dalenewman
  • 1,234
  • 14
  • 18
10
votes
1 answer

DocFX: Generate API documentation for multiple projects

I'm working on a project that has multiple projects in a solution. I would like to be able to generate the documentation from an outside directory to keep the application code folders clean. When I try to set the src directory in my docfx.json, it…
Terry Palmer
  • 103
  • 1
  • 5
8
votes
2 answers

How to generate documentation with DocFX using XML documentation file?

I want to create something like API documentation website for a .NET project. As per .NET Docs the XML comments that we put on top of methods, classes etc. can be processed into an XML file by the compiler and that file can be run through tools like…
Baljeet Singh
  • 122
  • 2
  • 11
8
votes
1 answer

How can I customize Docfx documentation (themes or templates)?

I just started using Docfx and set up some basic conceptual documentation. Now I want to make some adjustments to the theme (company logo, perhaps some font changes, etc.) Minor stuff. The official documentation only gives a high-level description…
enzi
  • 4,057
  • 3
  • 35
  • 53
6
votes
2 answers

DocFx: how to suppress certain info about type (inheritance, constructors, assembly etc)

I am using DocFx to generate documentation about a WCF web-service. The target audience for the documentation is clients of the web-service. These clients obviously do not have access to the .NET binaries directly. Documentation of the public…
Laurence
  • 980
  • 12
  • 31
6
votes
1 answer

How to lower docfx verbosity?

We use docfx, it is included as a nuget in one of our csproj files. I didn't personally setup the thing and I have no more information on how it works, but it looks like a simple nuget added to a C# project which then produces the documentation…
Al Kepp
  • 5,831
  • 2
  • 28
  • 48
6
votes
1 answer

PlantUml does not render diagram after build docfx

https://github.com/KevReed/DocFx.Plugins.PlantUml I had installed plantUml for docfx plugin via nuget. by nuget install DocFx.Plugins.PlantUml -ExcludeVersion -OutputDirectory . command, after that I got this result after build docfx, and I checked…
Seon Myeong Kim
  • 61
  • 2
6
votes
2 answers

How to create a searchable central repository of code documentation using DocFx

I'm looking to create a central repository for all of our published API documentation using DocFx. I have documentation auto-generated via my build (using TFS) and published through my release (using Octopus) just fine for multiple individual sites.…
Scott Benners
  • 61
  • 2
6
votes
1 answer

DOCFX format tables using markdown without changing the template

Is it possible to change the layour of a table using markdown under docfx? For example, the following table is not very good readable, because of the spacing between the columns. Event there is no alternating row color: | Property | Description…
BendEg
  • 20,098
  • 17
  • 57
  • 131
5
votes
1 answer

docfx menu missing "Articles", "Api Documentation" when hosted from filesystem but show up on localhost:8080

When I run docfx docfx.json --serve and go to localhost:8080, I see two items on the top menu: "Articles" and "Api Documentation". When I navigate in the filesystem to _site\ and click on index.html to open it in Chrome, these menu items are…
devlord
  • 4,054
  • 4
  • 37
  • 55
5
votes
3 answers

How can I add .NET namespace information in DocFX

The title says it all ... In Sandcastle Help File Builder we added the NamespaceDoc class to each namespace to create namespace documentation. How do we to the same using DocFX?
AxD
  • 2,714
  • 3
  • 31
  • 53
5
votes
2 answers

How to change the footer in DocFX?

Just hope to change the footer copyright info, generated by DocFX. Here is what I have done: Export template: Run docfx template export default, get a folder _exported_templates\default Change the footer partials: The files I have changed are…
Blaise
  • 21,314
  • 28
  • 108
  • 169
4
votes
1 answer

How to document union types in typescript?

How to document Union type in typescript so typedoc can pull/show relevant info? This below is a JSDoc reference but is there one for TSDoc? Example /** * Search parameters * These comments are not picked up, I generate blank page */ export type…
Dino
  • 161
  • 1
  • 13
1
2 3
…
8 9