À propos de DocFX
DocFX is a powerful documentation generator that converts .NET assemblies, XML code comments, REST API Swagger files, and Markdown into polished HTML pages, JSON models, or PDF files. Create, preview, and publish static documentation sites effortlessly with built-in tools for GitHub Pages deployment and NuGet library integration.
FAQ
You need familiarity with the command line, .NET SDK 8.0 or higher, and Node.js v20 or higher (required for PDF generation).
Run the command 'docfx init' in your terminal to create a new docfx project in the current working directory.
After building the docset with 'docfx docfx.json --serve', you can preview the site at http://localhost:8080.
Enable GitHub Pages, upload the _site folder to GitHub Pages using GitHub Actions, and use the provided workflow example to automate the process.
Yes, you can include docfx as a NuGet library in your project by adding the specified PackageReference entries and using the provided API methods.
You can install a prerelease version by using the GitHub CLI to authenticate, download the nupkg from GitHub Packages, and install it as a .NET Global Package from the local source.
Alternatives à considérer
Voir toutes les alternatives
Badges
Faites la promotion de DocFX et donnez-lui plus de visibilité en ajoutant ces badges à votre site web, votre documentation ou votre fiche produit. Chaque badge renvoie vers la page de DocFX sur Webfolio.
<a href="https://www.webfolio.to/tools/docfx?utm_source=badge&utm_campaign=badge" target="_blank" rel="noopener noreferrer"><img src="https://www.webfolio.to/badges/featured_color.svg" alt="Mis en avant sur Webfolio" style="max-width: 150px" /></a>
Catégories
Revendiquer cet outil
Vous êtes le fondateur ? Revendiquez votre profil pour mettre à jour les détails et suivre les vues.