# 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

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 ·

Static site generator for .NET API documentation. Contribute to dotnet/docfx development by creating an account on GitHub.

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 ?

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...

June 19, 2022 - So clone the DocFX project, and switch to the v3-template branch: git clone https://github.com/dotnet/docfx cd docfx git checkout v3-template

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 the release of v3 ?

Static site generator for .NET API documentation. Contribute to dotnet/docfx development by creating an account on GitHub.

Hello since October there is a ... 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. See #8277 (comment) Beta Was this translation helpful? Give feedback. ... Sign up for free to join this conversation on GitHub...

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.

May 26, 2024 - First, install DocFX globally on your system. You can do this using the dotnet command line tool on Windows or by downloading it directly from the official website: https://dotnet.github.io/docfx/

The project maintainers are looking at pulling some of the more useful features of V3 back into the main branch but we're not going forward with V3 so I don't think it will ever be implemented/fixed in that branch. ... Sign up for free to join this conversation on GitHub.

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.

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 ...

August 25, 2021 - docfx v3 nuget package

December 20, 2021 - Our workflows publish the documentation to a branch called gh-pages. Select the gh-pages branch in the first drop down, / (root) in the second drop down and click Save. Our documentation site is now available on the url shown, in this case: https://irongut.github.io/DocFXExample/ 🎉

April 28, 2024 - Let’s add a YML docfx.yml file to the .github/workflows folder: on: push jobs: generate-docs: runs-on: windows-latest steps: - uses: actions/checkout@v2 - name: Setup .NET 6.0 uses: actions/setup-dotnet@v1 with: dotnet-version: 6.0.x - name: Setup DocFX uses: crazy-max/ghaction-chocolatey@v1 with: args: install docfx - name: DocFX Build run: docfx .\docfx.json continue-on-error: false - name: Publish uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: _site force_orphan: true

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

October 20, 2021 - # However, do NOT cancel in-progress ... 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/uplo...