Voltstro
voltstro.dev › blog › 2022 › 06 › 19 › using-docfx-v3
Using DocFX V3 | Voltstro
June 19, 2022 - Yes, DocFX V3 is a thing.
.NEXT
dotnet.github.io › docfx
Quick Start | docfx - Microsoft .NET - GitHub Pages
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. concurrency: group: "pages" cancel-in-progress: false jobs: publish-docs: environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v3 - name: Dotnet Setup uses: actions/setup-dotnet@v3 with: dotnet-version: 8.x - run: dotnet tool update -g docfx - run: docfx <docfx-project-path>/docfx.json - name: Upload artifact uses: actions/upload-pages-artifact@v3 with: # Upload entire repository path: '<docfx-project-path>/_site' - name: Deploy to GitHub Pages id: deployment uses: actions/deploy-pages@v4
DocFx V3 How to use it?
I just downloaded the last V3 version, an I wonder how to use it ? Everything has changed since V2. Is there any documentation or tutorial about it ? Thanks. More on github.com
1
December 6, 2018[Question] When is docfx v3 scheduled for release?
Hi, are there any news regarding a planned release date for docfx v3? Right now we are thinking about using v3 for our documentation, but if it is still far away we might simply go ahead and use v2. Especially important for us is generat... More on github.com
46
February 8, 2021Docfx v3: Is the versioning design working?
The versioning design specs were developed a long time ago. It seems that the objective was to make monikers easier without the need of specifying complex and hard to understand configurations with... More on github.com
1
2
April 4, 2022Docfx V3 startup guide document
Add a startup guide to README How to run docfx restore How to run docfx build More on github.com
2
July 12, 2018GitHub
github.com › dotnet › docfx › issues › 5876
[Question] Is there a planned date for the release of docfx v3 ? · Issue #5876 · dotnet/docfx
May 8, 2020 - I have looked at the roadmap of v3 but there are not expected or planned date for the release. Is it something known ? In order to try and get started with docfx is it better to go v2 or wait for t...
Author: dotnet
GitHub
github.com › dotnet › docfx › issues › 3737
DocFx V3 How to use it? · Issue #3737 · dotnet/docfx
December 6, 2018 - DocFx V3 How to use it?#3737 · Copy link · Julien-Marpault · opened · on Dec 6, 2018 · Issue body actions · I just downloaded the last V3 version, an I wonder how to use it ? Everything has changed since V2. Is there any documentation or tutorial about it ?
Author: dotnet
GitHub
github.com › dotnet › docfx › discussions › 8277
[Question] When is docfx v3 scheduled for release? · dotnet/docfx · Discussion #8277
As you can imagine, this also has the side effect of dramatically reducing Learn's dependency on DocFX to generate content. It's still present, but the build system only uses pieces of it, and the produced output is more of an intermediate format than the final HTML. Given these changes in the publishing model, it made sense to stop the official development of V3 - so you won't see any more work on that branch for the Learn site itself.
Author: dotnet
GitHub
github.com › dotnet › docfx › discussions › 8355
the future of docfx v3 · dotnet/docfx · Discussion #8355
Hello since October there is a slowdown in the development of beta versions of docfx? Do you have more information? Beta Was this translation helpful? Give feedback. ... There was an error while loading. Please reload this page. Something went wrong. There was an error while loading. Please reload this page. ... V3 will be for Microsoft internal use only.
Author: dotnet
GitHub
github.com › dotnet › docfx › issues › 7050
[Question] When is docfx v3 scheduled for release? · Issue #7050 · dotnet/docfx
February 8, 2021 - Hi, are there any news regarding a planned release date for docfx v3? Right now we are thinking about using v3 for our documentation, but if it is still far away we might simply go ahead and use v2. Especially important for us is generat...
Author: dotnet
GitHub
github.com › dotnet › docfx › tree › v3
GitHub - dotnet/docfx at v3 · GitHub
dotnet tool update -g docfx --version "3.0.0-*" --add-source https://docfx.pkgs.visualstudio.com/docfx/_packaging/docs-public-packages/nuget/v3/index.json · Create a directory for your website: mkdir my-website cd my-website · Create a new website: docfx new conceptual ·
Starred by 4.4K users
Forked by 886 users
Languages: C# 94.1% | JavaScript 3.2% | TypeScript 1.3% | CSS 0.5% | SCSS 0.4% | Go Template 0.3%
NuGet
nuget.org › packages › docfx › 2.63.0
NuGet Gallery | docfx 2.63.0
March 20, 2023 - For Microsoft Learn users, the open source version of docfx will NOT be maintained to support Microsoft Learn content. For Microsoft Learn feature requests, bug reports and other support ticks, use internal channels such as the Learn Platform Support Channel. V3 branch has been privatized to support Microsoft Learn, the development of V3 branch in the public is officially stopped.
SourceForge
sourceforge.net › projects › docfx.mirror
DocFX download | SourceForge.net
February 24, 2026 - This is an exact mirror of the DocFX project, hosted at https://github.com/dotnet/docfx.
GitHub
github.com › dotnet › docfx › releases
Releases · dotnet/docfx
feat: Add noRestore option to docfx metadata command by @filzrev in #10428
Author: dotnet
Medium
medium.com › hitachisolutions-braintrust › getting-started-with-docfx-c710dad2e8c9
Getting Started With DocFX | Hitachi Solutions Braintrust
December 13, 2021 - According to the GitHub repository though, the team is working on supporting it and it is expected to be released with version 3 of DocFX. However, there is no ETA on when V3 will be released.
Medium
medium.com › @fabiosalomao › creating-a-cli-part-4-automating-documentation-for-your-cli-with-docfx-and-github-pages-7ea57fabebc4
Creating a CLI - Part 4: Automating Documentation for Your CLI with DocFX and GitHub Pages | by Fábio Salomão | Medium
May 26, 2024 - name: CI on: push: branches: - ... Checkout uses: actions/checkout@v3 - name: Dotnet Setup uses: actions/setup-dotnet@v3 with: dotnet-version: 8.x - run: dotnet tool update -g docfx - run: docfx docfx.json - name: Upload artifact uses: actions/upload-pages-artifact@v3 with: ...
Author: dotnet
GitHub
github.com › dotnet › docfx › issues › 3058
Docfx V3 startup guide document · Issue #3058 · dotnet/docfx
July 12, 2018 - Docfx V3 startup guide document#3058 · Copy link · Assignees · OsmondJiang · opened · on Jul 12, 2018 · Issue body actions · Add a startup guide to README · How to run docfx restore · How to run docfx build · Reactions are currently unavailable · Sign up for free to join this conversation on GitHub.
Author: dotnet
Code Maze
code-maze.com › home › generating source code documentation with docfx
Generating Source Code Documentation With DocFx - Code Maze
April 28, 2024 - How using the open-source tool DocFx allows us to have our source code automatically documented for maximum productivity.
GitHub
github.com › dotnet › docfx › issues › 3958
DocFX V3 DocFX.yml · Issue #3958 · dotnet/docfx
January 22, 2019 - I use DocFX V3 last build, an d I am in trouble with docfx.yml. I tried to put docfx.json properties to docfx.yml but it doesn't work. I get this error message: unknown-field docfx.yml(0,0): Could not find member 'metadata' on object of ...
Author: dotnet
GitHub
github.com › dotnet › docfx › issues › 9901
[Bug] Can't install docfx v3 from https://docfx.pkgs.visualstudio.com/docfx/_packaging/docs-public-packages/nuget/v3/index.json · Issue #9901 · dotnet/docfx
April 30, 2024 - It seems something around docfx nuget feed has changed on 4/29. If I try dotnet tool update -g docfx --version "3.0.0-*" --add-source https://docfx.pkgs.visualstudio.com/docfx/_packaging/docs-public-packages/nuget/v3/index.json
Author: dotnet
Top answer 1 of 4
3
I finally found the problem. The issue for me was the folder configuration. I had to move my docfx.json, toc.yml, and index.md to the top level where my .sln file was because it was accessing multiple .csproj files. I didn't realize that the top-level toc.yml could only access folders under it's current location.
Furthermore, the top-level toc.yml will only create the menu items across the top of the page. The lower-level toc files will create the TOC on the left side of the page.
It took some digging into the tutorial to figure this out.
2 of 4
2
For me, what worked was a change to the root toc.yml. The href with a file name like /index.md does not work, but with the folder it does.
Wrong: root toc.yml
- name: Articles
href: articles/index.md
- name: API
href: api/index.md
Good: root toc.yml
- name: Articles
href: articles/
- name: API
href: api/
topicHref: api/some.md
GitHub
github.com › dotnet › docfx
GitHub - dotnet/docfx: Static site generator for .NET API documentation. · GitHub
Static site generator for .NET API documentation. Contribute to dotnet/docfx development by creating an account on GitHub.
Author: dotnet