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
1
vote
1 answer

How to change the header color in docfx standard template

Have been struggling with the header color in the css for some while. I was able to change the footer, but not sure how to access the header element and change the color. Please reference the screenshot for context
Junior
  • 43
  • 3
1
vote
0 answers

How can I change the names of the items in the side toc (DocFX)

I am working with docfx, and I would like to change the title of the items in the side table of contents. I know that for this I need to generate a new toc.yml file in the api subfolder when I run the following command:docfx…
Cracho
  • 43
  • 4
1
vote
0 answers

How to let DocFX style custom comment

DocFX generates documentation from c# based on comments like \, but let's say I want all the comment that start with \@ have another styling or become hidden in the generated documentation, how can I implement this? There is no information about…
Malle Joepoe
  • 11
  • 4
1
vote
4 answers

Docfx 3.0.0 How to get the TOC on the Index.html

This question is the same as this question. But the OP answered his own question and it didn't help me. I am trying to create a documentation similar to the Docfx site: However, when I build the project, I get the index.html that looks like…
Alexa Kirk
  • 152
  • 10
1
vote
0 answers

DocFx with a parent-children doc site and multiple separate projects in various repos

I need your guidance... Given that an organization may have multiple products in various repositories, and probably many documentation repositories, how to integrate everything in one "docs.acme.com" site ? For example: 3 products: X, Y and Z, and Z…
Patrice Calvé
  • 674
  • 6
  • 12
1
vote
0 answers

Make DocFX only generate for one build configuration

I want DoxFX to generate docs only when I select the build configuration "Release+Docs" because it wastes a lot of time when testing otherwise. I've added this line to the docfx.console.targets, but it seems ineffective. The docs are generated…
Tyron
  • 1,938
  • 11
  • 30
1
vote
2 answers

docfx metadata step fails with error "Could not load SDK Resolver"

Whenever I try to build any documentation using docfx, I get the following error in the metadata build step that uses msbuild to analyze the xml comments in the code of the csprojs: Warning:MetadataCommand.ExtractMetadataWorkspace failed with:…
bitbonk
  • 48,890
  • 37
  • 186
  • 278
1
vote
0 answers

docfx generation with preprocessor directives (symbols/constants)

I have set up a docfx project to generate documentation from the source code for a c# library project. However, it doesn't seem to work when I have preprocessing directives in, for example: #if NET48 /// /// An example class. ///…
SamWM
  • 5,196
  • 12
  • 56
  • 85
1
vote
2 answers

Cannot launch my docfx project due to pathing problem

I have a DocFx project folder which contains all the correct files to host the project. On my laptop, I'm able to use the code docfx docfx.json --serve to host the project on my localhost completely fine. However on my PC it errors out. I'm syncing…
AidenC
  • 11
  • 2
1
vote
1 answer

How can I surface TOC items within docfx that are not directly tied to content?

I am in the process of porting the NUnit docs from their GitHub wiki to docfx. I am trying to understand if this is expected behavior or if there is something I can do within my config file to prevent it. Pull nunit/docs repo cd docs docfx build;…
SeanKilleen
  • 8,809
  • 17
  • 80
  • 133
1
vote
1 answer

How to turn off DocFX build each time i rebuild project in Visual Studio [2019] [NuGet]

I tried to start using DocFX and it meets my requirements, but I have a minor problem that is quite bothersome in the long run. Every time I change something in the project and enable debugging, the DocFX's nuget adapts to the new changes. This is…
Walczak Jakub
  • 92
  • 1
  • 10
1
vote
1 answer

xmldoc with cref that refers to a class under a separate csproj

We have an SDK project that includes a test engine. These live under two different csproj's. So we have SDK.csproj and TestEngine.csproj where SDK.csproj is a ProjectReference. I have a DocFx project set up that builds metadata for these two…
ryryguy
  • 610
  • 4
  • 15
1
vote
1 answer

Using tags in DocFX markdown frontmatter / YAML header

I have a DocFX site with a number of pages. I would like to include tags at the top of each page via custom template, and I'd like for authors to be able to add tags in the YAML frontmatter, e.g.: --- title: My Page Title tags: tag1;tag2;tag3 --- I…
darth_phoenixx
  • 932
  • 12
  • 23
1
vote
2 answers

Change width of sidetoc

Basically I am trying to change the width of the navigation on the left side (sidetoc). Some of my namespaces and Types are wider in width than the sidetoc allows and therefor breaks in a newline, which I really want to avoid. Is there any way to…
Twenty
  • 5,234
  • 4
  • 32
  • 67
1
vote
1 answer

How to generate documentation with references using docfx

I am trying to generate documentation for .net project (multi layer). But I am not able to see reference class information in generated documentation with docfx. Eg: using Microsoft.AspNetCore.Mvc; using ServiceLayer; namespace…
Ramakrishna Yelduti
  • 437
  • 4
  • 22
1 2 3
…
8 9