docfx C# (Comment ça fonctionne pour les développeurs)

Comment utiliser DocFX

1. Installez .NET SDK 6.0+
2. Ouvrez PowerShell.
3. Exécutez le script une par une pour installer la bibliothèque DocFX.
4. Après l'installation, exécutez le fichier JSON.
5. Cela ouvre le site de documentation sur le port 8080.

Introduction à DocFX

Microsoft a créé l'outil open-source de génération de sites statiques et de documentation DocFX. Avec l'aide de fichiers Markdown et de code source, les développeurs peuvent produire des sites de documentation qui ont l'air professionnel. DocFX est adaptable et largement applicable à une variété de projets car il prend en charge une multitude de formats de balisage et de langages de programmation.

Les développeurs peuvent créer des tutoriels, des articles conceptuels et des références d'API dans leur documentation en utilisant DocFX. Grâce à son architecture flexible, les équipes peuvent le personnaliser et l'étendre pour répondre à leurs besoins uniques. DocFX offre également des fonctionnalités telles que la création de références croisées, des modèles éditables et la prise en charge de plusieurs formats de sortie, y compris HTML et Markdown. Pour une description plus détaillée du fonctionnement interne et des méthodes de DocFX, veuillez visiter la Documentation DocFX.

Commencer avec DocFX

Créer un nouveau site Web DocFX

Nous allons créer un site web de documentation de base sur votre ordinateur local à cette étape.

• Une compréhension de base des opérations en ligne de commande est nécessaire.
• Une version de .NET SDK 6.0 ou ultérieure est requise.

Pour installer la version la plus récente de DocFX, assurez-vous que vous avez installé le .NET SDK, puis ouvrez un outil de ligne de commande terminal et tapez la commande suivante :

dotnet tool update -g docfx

Pour démarrer un ensemble de documents frais, exécutez :

docfx init

docfx init

Cela crée un fichier JSON de toutes les configurations. Avec l'aide de cette commande, vous pouvez créer un nouveau projet DocFX dans le répertoire de travail actuel. Pour créer l'ensemble de documents, exécutez :

docfx docfx.json --serve

docfx docfx.json --serve

La page web peut maintenant être prévisualisée sur http://localhost:8080.

Enregistrez vos modifications. DocFX est configuré à l'aide du fichier de configuration JSON. Maintenant, nous utilisons un nouveau terminal pour exécuter cette commande pour reconstruire le site web et prévisualiser vos modifications locales :

docfx docfx.json

docfx docfx.json

Fonctionnalités de DocFX

Intégration de DocFX avec IronPDF

En combinant DocFX avec IronPDF, les développeurs peuvent tirer parti des avantages de chaque outil et améliorer leur processus de documentation. Les développeurs peuvent garantir une présentation cohérente sur tous les appareils, créer une documentation prête à fonctionner hors ligne et faciliter le partage et la distribution en utilisant IronPDF pour convertir la documentation HTML générée par DocFX au format PDF. Pour en savoir plus sur IronPDF, veuillez vous référer à la documentation IronPDF.

Installer IronPDF

• Démarrez le projet Visual Studio.
• Choisissez "Outils" > "Gestionnaire de packages NuGet" > "Console du gestionnaire de packages".
• Dans la console du gestionnaire de packages Visual Studio, tapez la commande suivante (corrigez cette ligne pour une commande d'installation de package appropriée) :

Install-Package IronPdf

• Alternativement, vous pouvez installer IronPDF en utilisant le gestionnaire de packages NuGet pour solutions.

• Vous pouvez sélectionner le package IronPDF dans les résultats de recherche, puis cliquer sur l'option "Installer". Visual Studio gérera le téléchargement et l'installation en votre nom.

  

• NuGet installera le package IronPDF avec toutes les dépendances nécessaires pour votre projet.
• Après l'installation, IronPDF peut être utilisé dans votre projet.

Implémentation de la logique

La logique suivante est impliquée dans le processus d'intégration :

1. Créer de la documentation avec DocFX : Pour commencer, utilisez DocFX pour créer votre documentation. Pour générer de la documentation HTML, cela implique d'exécuter le processus de construction DocFX sur le code source et les fichiers Markdown de votre projet.
2. Utiliser IronPDF pour convertir la documentation HTML en PDF : Après que la documentation HTML a été créée, utilisez IronPDF pour la convertir au format PDF. Convertir du texte HTML en documents PDF imprimables est facile en utilisant les fonctionnalités de conversion HTML en PDF de IronPDF.
3. Automatiser le processus de conversion : Utilisez du code C# ou des scripts pour automatiser le processus de conversion afin d'optimiser le flux de travail. Cela garantit que la documentation peut être facilement mise à jour et régénérée si une intervention manuelle n'est pas requise.

using IronPdf;

class Program
{
    static void Main()
    {
        // Create a new HtmlToPdf Renderer
        var Renderer = new HtmlToPdf();

        // Render the webpage as PDF
        var PDF = Renderer.RenderUrlAsPdf("http://localhost:8080/index.html");

        // Save PDF to a file
        PDF.SaveAs("output.pdf");

        // Inform the user of successful PDF creation
        Console.WriteLine("PDF generated successfully!");
        Console.ReadKey();
    }
}

using IronPdf;

class Program
{
    static void Main()
    {
        // Create a new HtmlToPdf Renderer
        var Renderer = new HtmlToPdf();

        // Render the webpage as PDF
        var PDF = Renderer.RenderUrlAsPdf("http://localhost:8080/index.html");

        // Save PDF to a file
        PDF.SaveAs("output.pdf");

        // Inform the user of successful PDF creation
        Console.WriteLine("PDF generated successfully!");
        Console.ReadKey();
    }
}

Imports IronPdf

Friend Class Program
	Shared Sub Main()
		' Create a new HtmlToPdf Renderer
		Dim Renderer = New HtmlToPdf()

		' Render the webpage as PDF
		Dim PDF = Renderer.RenderUrlAsPdf("http://localhost:8080/index.html")

		' Save PDF to a file
		PDF.SaveAs("output.pdf")

		' Inform the user of successful PDF creation
		Console.WriteLine("PDF generated successfully!")
		Console.ReadKey()
	End Sub
End Class

Pour en savoir plus sur l'exemple de code, consultez ce guide d'utilisation de l'exemple. Le résultat de l'exécution est indiqué ci-dessous :

Conclusion

Enfin, les développeurs disposent d'une option puissante pour créer et diffuser une documentation excellente au format PDF en intégrant DocFX avec IronPDF en C#. Les développeurs peuvent produire une documentation extensive prête à être utilisée hors ligne qui est facilement accessible et partagée en combinant les capacités de production de PDF de DocFX et IronPDF pour la génération de documentation. Cette intégration améliore le flux de travail de documentation, améliore la lisibilité et l'accessibilité de la documentation de projet, et augmente les chances de succès des projets logiciels.

Les développeurs peuvent optimiser leurs procédures de documentation, améliorer la collaboration et la communication, et offrir de meilleures expériences de documentation pour les utilisateurs et les parties prenantes en implémentant les recommandations de cet article et en utilisant les capacités de DocFX et IronPDF.

Le pack $799 Lite comprend une licence perpétuelle, un an de maintenance logicielle et une mise à niveau vers la bibliothèque. IronPDF offre des licences gratuites avec des restrictions sur la redistribution et le temps. Les utilisateurs peuvent évaluer la solution pendant la période d'essai sans avoir à voir un filigrane. Pour des informations supplémentaires sur le prix et la licence, veuillez consulter les détails de la licence de IronPDF.