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
2
votes
1 answer

How do I configure DOCFX to show source code on each page

Would like to include a view into the source code for each page, but don't know what option to change in docfx.json to do it. Please advise.
JWP
  • 6,672
  • 3
  • 50
  • 74
2
votes
1 answer

DocFX generating documentation for a project in a different folder

I have the structure of the file: I want to use DocFX to create documentation of my project but my problem is file docfx.json. My project is in another folder like C:\Test\ConsoleApp1\ConsoleApp1 not in src folder in docFx, when I try to change…
Andreas
  • 63
  • 6
2
votes
1 answer

Error extracting metadata in docfx project

Despite reading through the docfx documentation, and numerous Github issues, I am unable to get my docfx project working. Steps taken: Initialise root directory docfx init -q Build from root directory docfx build (no errors) Serve docfx…
burntsugar
  • 57,360
  • 21
  • 58
  • 81
2
votes
0 answers

How can I configure DocFX to increase the column width for documentation about method parameters?

As you can see in the screenshot below, the Type column is not wide enough, and therefore its content is wrapped. This looks ugly. How might I increase the column width?
Rock Anthony Johnson
  • 159
  • 11
2
votes
1 answer

using the docfx.console nuget package on linux

At the moment I have a visual studio project and I use the docfx.console nuget package to build the documentation, and everything works fine and as expected... on windows. The point is now I want to make a docker image based on…
Maarten Derickx
  • 1,502
  • 1
  • 16
  • 27
2
votes
1 answer

Is it possible to generate docfx documentation from multiple repositories?

I have multiple docfx documentation in different repositories. How can I merge these documentation into one docfx project that contains multiple others? Using docfx Cross Reference between Projects didn´t solve my problem since it just links me…
T.Harms
  • 43
  • 4
2
votes
1 answer

DocFx does not generate documentation

I'm trying to use DocFx to generate API documentation. I was under the impression that if I added docfx.console as a nuget package to my .NET project and built it, the documentation would be generated automatically. But that does not seem to be…
Debadeep Sen
  • 435
  • 7
  • 18
2
votes
1 answer

DocFx reference markdown different project

We are working on a multi-Project *.sln Solution and can successfully generate an API Documentation with *.md Articles for it using DocFx in a separate Asp.Net Web csproj only for documentation. But we want to maintain and reference local Markdown…
Spoc
  • 668
  • 5
  • 14
2
votes
1 answer

Are the dotnet utilities (dnu) retired? What replaces the global commands?

Following the sphinx-autoapi integration with docfx guide, they suggest installing docfx using the following command: Install DocFX using DNU (deprecated ?) dnu commands install docfx Did DNU get retired - I just ended up using chocolatey, but it…
SliverNinja - MSFT
  • 31,051
  • 11
  • 110
  • 173
2
votes
1 answer

Docfx API Reference - does not resolve see tag

I followed this tutorial to create a API documentation for a class library. In the comments of my class library I us the see tag to reference other types. For example, this is the comment of a class containing extension methods for…
musium
  • 2,942
  • 3
  • 34
  • 67
1
vote
0 answers

How to fix syntax highlighting in examples

I have noticed that in my DocFX output the syntax highlighting is not correct for the examples, meaning example code inside ... doc comments, even though the API signatures are highlighted correctly. It seems that…
Yevgeniy P
  • 1,480
  • 1
  • 15
  • 23
1
vote
0 answers

How to generate JavaScript DocFX documentation in an MVC project?

I've successfully generated a documentation website with DocFX for C# of apps written with .NET Core MVC and Razor Pages. The DocFX guide says it also supports generating API documentation for JavaScript. I want to do that for files in wwwroot…
Lukas
  • 1,699
  • 1
  • 16
  • 49
1
vote
1 answer

DocFX - how to place an export to PDF button on header/footer

I'd like to place a button on the header/footer of the docfx generated site that is when clicked it downloads an already generated/saved PDF in the asset folder of the site. Tried to scour the web for documentation on how to go about this but I…
Junior
  • 43
  • 3
1
vote
2 answers

Docfx custom triple slash tag

I want to specify custom /// tag (ex. EcsComponent) that will be added to generated .yml file. And later render some additional info (link to external site) for marked classes. Are the any way to do it? I see some examples of plugins for processing…
Антон Гааг
  • 11
  • 2
1
vote
1 answer

Docfx PlantUml Metadata

Is there a sample code for using PlantUml in metadata(Api documentation) Docfx? it is like this image For example, the following picture is another place that's means article menu no on metadat
samira_maleki
  • 65
  • 5
1 2
3
…
8 9