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
4
votes
2 answers

docFX - Remove namespace prefix in API Reference TOC

I am generating API reference from C# project. The project is part of big solution and has long name convention for assemblies and namespaces, so every namespace in project goes like [CompanyName].[System].[Area].[Module].[...] (e.g.…
Alex Michel
  • 416
  • 3
  • 13
4
votes
1 answer

DocFx: how to create table of contents navigation on site?

I want to create a table of contents that looks like what DocFx has on their official site: Using the default docfx init command using all of the default values my website looks like this upon build: \ I've tried tampering with the toc.yml files…
Aaronontheweb
  • 8,224
  • 6
  • 32
  • 61
3
votes
1 answer

System.*, Microsoft.* classes not resolved under .NET 6

I'm digging into DocFX. My projects are all using either .NET Standard 2.1 or 6. I've come across an issue where classes, structs, interfaces that are in either System.* or Microsoft.* are not being resolved. The DocFX metadata command generates…
mhsimkin
  • 311
  • 4
  • 15
3
votes
1 answer

GitHub Codespaces 502 Gateway Error Serving a docfx site

I am working to add GitHub Codespaces to the NUnit docs repository for document editing. We're really excited about the potential of Codespaces for our use case! The Current Ingredients PR to add codespaces, which has our configuration files and…
SeanKilleen
  • 8,809
  • 17
  • 80
  • 133
3
votes
1 answer

How to show content inside see cref in XML comment from Intellisense and DocFx?

I have used XML comment on a property which is a type of List. However when I hover my mouse to that property, Visual Studio shows it as List. When I build the documentation with docFx, it still renders the comment as List instead of…
Unknown
  • 778
  • 1
  • 7
  • 16
3
votes
1 answer

DocFX (in Azure DevOps): The imported project "\15.0\Microsoft.Common.props" was not found

I get these warning when trying to generate DocFX documentations from an Azure DevOps build task (it works fine locally): Build succeeded with warning. [19-04-25…
Maxime Gélinas
  • 2,202
  • 2
  • 18
  • 35
3
votes
1 answer

How to switch off DocFX in visual studio in debug mode while active in release mode?

I added DocFX to visual studio to generate web documents for my C# code. However, for every compilation it creates new documents which takes long time. Is there a way to switch it off in visual studio when I don't need it? I know it is possible to…
Sorush
  • 3,275
  • 4
  • 28
  • 42
3
votes
1 answer

DOXFX using Application Insights end-user user analytics

How can you add Application insights end-user user analytics to DocFx to track the usage of every documentation page? The Application Insights documentation states you need to insert the JavaScript snippet listed below immediately before the closing…
Rob
  • 31
  • 4
3
votes
1 answer

DocFX relative path to 'src' folder

There's something I'm missing in DocFX configuration - so it does not generate proper documentation. I have a following folder structure: +Documentation |- _site |- api |- apidoc |- articles |- images |- src <-- This folder is…
Alex F
  • 3,180
  • 2
  • 28
  • 40
3
votes
1 answer

Docfx, how can make it render correctly accents characters?

I'm compiling a documentation with DocFx from Visual Studio with the NuGet package. I write in Italian and we have a lot of characters like: à è ì ò ù. In the final render, my page looks like this: The final html looks like this: How can I make it…
Francesco Bonizzi
  • 5,142
  • 6
  • 49
  • 88
3
votes
1 answer

DocFX output to Markdown

Looking at the flow DocFX seems to create .md files and then convert that to html when creating documentation. Is there a way to make DocFX output to .md files instead of html ?
Orn Kristjansson
  • 3,435
  • 4
  • 26
  • 40
2
votes
0 answers

Is there a way to replace the PlantUmlModel tag with the PlantUml script?

Is there a way to replace the PlantUmlModel tag with the PlantUml script when the project is compiled? I do use Docfx to generate documentation /// /// /// public interface…
samira_maleki
  • 65
  • 5
2
votes
1 answer

DocFX offline documentation

Is there a way to deploy DocFX generated documentation as offline webpage? Currently I need to serve it on localhost to view it. Without it, I have the single pages for each class but I cant navigate through them etc.
Rikib1999
  • 199
  • 7
2
votes
0 answers

How to create docfx documentation from Typescript code?

I have found this page on docfx site https://dotnet.github.io/docfx/tutorial/universalreference/gen_doc_for_ts.html and it mentions Type2docfx npm library. But what I found is that the latest version of Type2docfx doesn't work with the latest TSDoc…
Vineet Mimrot
  • 99
  • 1
  • 6
2
votes
0 answers

Preserving Tags in DocFX Conceptual Documentation

I want DocFx to preserve or escape tags such as < and > in the content of generated html files. Currently, DocFx converts < and > to < and > respectively in the generated html file content. I am looking for a way to pass dynamic data to the…
Daniel Oppong
  • 158
  • 1
  • 10
1
2
3
…
8 9