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

docfx project with git under tfs

I'm trying to create docfx project. Sources are hosted on TFS server in GIT repository. Everything is ok except absence of Improve this Doc link. Is there way to make this link appear and work for such configuration?
Boris Nikitin
  • 369
  • 4
  • 12
0
votes
1 answer

docfx Shared Content between Markdown Files

In DocFX, I have a block of content which i need to put on all (or most) markdown files. Is there a way to merge or pull the contents of another md file in to the current file? Basically i am trying not to repeat myself and looking for some sort of…
James Poulose
  • 3,569
  • 2
  • 34
  • 39
0
votes
1 answer

How do i use DocFX to generate c# documentation from source code without VS2017?

I am trying to follow the tutorial from the command line. I have generated the project and deployed the blank website then added a vs2012 project to the source folder maintaining the original heirarchy. I have edited the docfx.json file to include…
Ryan
  • 11
  • 2
0
votes
1 answer

DocFX (VB.net) - Support for Inline Comments

I am currently evaluating alternative solutions to producing API Documentation for our customers. Currently we use our own home-brewed solution, and I started some research. This was when I came across DocFX developed and used by Microsoft. Seemed…
M. Hopper
  • 3
  • 4
0
votes
1 answer

How do you create code references with custom link text in documentation comments?

I am porting an application library from Java to C#. In the Java documentation, there are places that link to a particular code reference using custom text. For example: Suffix --> {@link DataOutput#writeString String} I tried using a similar…
NightOwl888
  • 55,572
  • 24
  • 139
  • 212
0
votes
2 answers

Running docfx to generate documentation against a .net standard 2.0 project - msbuild error

I have a .net standard 2.0 class library. I have both VS 2017 and VS 2017 preview (for net core 2.0) installed. I am trying to run docfx to generate documentation for my library. I first faced an issue where I got the following…
jeff.eynon
  • 1,296
  • 3
  • 11
  • 29
0
votes
1 answer

Referring to toc.yml when generating conceptual html file

I am trying to create a DocFx template, using its support for moustache. I'd like to be able to generate a site menu, in the navbar of all the generated html pages, based on a toc.yml file in the project root. I know that the default template does…
Mark Olbert
  • 6,584
  • 9
  • 35
  • 69
-1
votes
0 answers

How to allow successful build of a docfx project without a valid path to wkhtmltopdf.exe?

I have a docfx project in my solution and I've configured it to create a PDF file of the user documentation. This function works well, but requires an installed local copy of wkhtmltopdf and the path to wkhtmltopdf.exe be set in docfx.json file. If…
Lukas
  • 1,699
  • 1
  • 16
  • 49
-1
votes
1 answer

Retrieve DocFx metadata from NuGet packages

I have a product with multiple repositories, each distributed as a NuGet package. I would like to establish a separate repository for DocFx, which generates the documentation from the NuGet packages. That way, it can consolidate the documentation…
Jeremy Caney
  • 7,102
  • 69
  • 48
  • 77
-1
votes
2 answers

How to link a html document with docfx

We're currently using docfx to generate html documentation for our code. We have additional html documents we'd link to include. So far I've included it as a resource section in docfx.json file, and that works, but docfx complains about any link I…
ESG
  • 8,988
  • 3
  • 35
  • 52
1 2 3
…
8
9