docfx C#（對於開發者的運行原理）

如何使用 DocFX

1. 安裝 .NET SDK 6.0+
2. 打開 PowerShell。
3. 一個一個地運行腳本以安裝 DocFX 函式庫。
4. 安裝完成後，運行 JSON 文件。
5. 這將在端口 8080 上打開文檔網站。

DocFX 簡介

DocFX 是微軟創建的開源靜態網站生成器和文檔生成工具。 借助 Markdown 文件和源代碼，開發者可以生成看起來專業的文件網站。 DocFX 非常靈活，可廣泛應用於各種項目，因為它支持多種標記格式和編程語言。

開發者可以使用 DocFX 在文檔中創建教程、概念性文章和 API 參考。 由于其靈活的架構，團隊可以自定義和擴展它以滿足他們的特殊需求。 DocFX 還提供了例如交叉引用、可編輯模板和支持多種輸出格式（包括 HTML 和 Markdown）等功能。 有關 DocFX 內部工作和方法的詳細描述，請訪問 DocFX 文檔。

開始使用 DocFX

創建 DocFX 新網站

在此階段，我們將在您的本地計算機上創建一個基本的文件網站。

• 需要對命令行操作有基本的了解。
• 需要 .NET SDK 6.0 或更高版本。

要安裝 DocFX 的最新版本，確保已安裝 .NET SDK，然後打開一個終端命令行工具並輸入以下命令：

dotnet tool update -g docfx

要啟動新的文檔集，請執行：

docfx init

docfx init

它創建所有配置的 JSON 文件。 借助此命令，您可以在當前工作目錄中創建一個新的 DocFX 項目。 要創建文檔集，請執行：

docfx docfx.json --serve

docfx docfx.json --serve

現在可以在 http://localhost:8080 上預覽網頁。

保存您的更改。 DocFX 使用 JSON 配置文件進行配置。 現在，我們正在使用新的終端執行此命令來重建網站並預覽您的本地更改：

docfx docfx.json

docfx docfx.json

DocFX 功能

將 DocFX 與 IronPDF 集成

通過將 DocFX 與 IronPDF 結合，開發者可以利用每個工具的優勢並改善其文檔流程。 開發者可以通過利用 IronPDF 將 DocFX 生成的 HTML 文檔轉換為 PDF 格式，確保在各種設備上的一致渲染，創建離線就緒的文檔，並使共享和分發變得更容易。 如需了解更多關於 IronPDF 的信息，請參閱 IronPDF 文檔。

安裝 IronPDF

• 開始 Visual Studio 項目。
• 選擇“工具” > “NuGet 套件管理器” > “套件管理器控制台”。
• 在 Visual Studio 套件管理器控制台中，輸入以下命令（將此行更正為正確的套件安裝命令）：

Install-Package IronPdf

• 或者，您也可以使用 NuGet 套件管理器為解決方案安裝 IronPDF。

• 您可以從搜索結果中選擇 IronPDF 套件，然後點擊“安裝”選項。 Visual Studio 將代表您處理下載和安裝。

  

• NuGet 將安裝 IronPDF 套件以及任何您項目所需的依賴項。
• 安裝完成後，IronPDF 即可在您的項目中使用。

實施邏輯

整合過程涉及以下邏輯：

1. 使用 DocFX 創建文檔： 要開始使用，請使用 DocFX 創建文檔。 這包括在您的項目源代碼和 Markdown 文件上運行 DocFX 構建過程以生成 HTML 文檔。
2. 使用 IronPDF 將 HTML 文檔轉換為 PDF： 在 HTML 文檔創建後，使用 IronPDF 將其程式化地轉換為 PDF 格式。 使用 IronPDF 的 HTML 啟 PDF 轉換功能，將 HTML 文本轉換為可打印的 PDF 文檔變得簡單易行。
3. 自動化轉換過程： 使用 C# 代碼或腳本自動化轉換過程，以優化工作流程。 這保證了如果不需要手動干預，文檔就可以很容易地更新和再生。

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

要閱讀更多有關代碼示例的信息，請參閱此 示例使用指南。 執行輸出如下所示：

結論

最後，通過在 C# 中將 DocFX 與 IronPDF 集成，開發者有了一個強有力的選擇來創建和轉發出色的 PDF 格式文刊。 開發者可以通過將 DocFX 和 IronPDF 的 PDF 生成能力相結合，用於文檔生成產生廣泛的、離線就緒的文檔，這是便捷且易於共享的。 此整合改進了文檔工作流程，提高了項目文檔的可讀性和可訪問性，增加了軟體項目成功的可能性。

通過實施本文中的建議並充分利用 DocFX 和 IronPDF 的功能，開發者可以優化其文檔流程，提高團隊合作和交流，並為用戶和利益相關者提供更佳的文檔體驗。

$799 精簡版套裝包括永久許可證、一年的軟件維護以及庫的升級。 IronPDF 提供有限的免費許可證，在重新分發和時間上有一定限制。用戶可以在檢驗期內評估解決方案而不必看到水印。 有關價格和許可的更多信息，請參見 IronPDF 的 許可細節。