docfx C#（開發者使用指南）

如何使用 DocFX

1.安裝 .NET SDK 6.0+ 2.Open PowerShell。 3.逐一執行腳本以安裝 DocFX Library。 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

要開始一個新的 docset，請執行：

docfx init

docfx init

它會建立一個包含所有配置的 JSON 檔案。 在此指令的幫助下，您可以在目前的工作目錄中建立一個新的 DocFX 專案。 若要建立 docset，請執行：

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 Package Manager">"Package Manager Console"。
• 在 Visual Studio Package Manager 主控台中，鍵入下列指令 (將此行修正為正確的套件安裝指令)：

Install-Package IronPdf

• 另外，您也可以使用 NuGet Package Manager for Solutions 安裝 IronPDF。

• 您可以從搜尋結果中選擇 IronPDF 套件，然後按一下"安裝"選項。 Visual Studio 將代您處理下載與安裝。

  。

• NuGet 將安裝 IronPDF 套件以及專案所需的任何相依性。
• 安裝完成後，IronPdf 即可在您的專案中使用。

實作邏輯

整合過程中涉及以下邏輯：

1.使用 DocFX 創建文件：要開始使用，請使用 DocFX 創建您的文件。 要產生 HTML 文件，這需要在專案的原始碼和 Markdown 檔案上執行 DocFX 建立程序。 2.使用 IronPDF 將 HTML 文件轉換為 PDF： 在建立 HTML 文件後，利用 IronPDF 程式化地將其轉換為 PDF 格式。 使用 IronPDF 的 HTML-to-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();
    }
}

若要閱讀更多關於程式碼範例的資訊，請參閱此 範例使用指南。 執行輸出如下所示：

。

結論

最後，透過在 C# 中整合 DocFX 與 IronPDF，開發人員有了一個強大的選擇，可以以 PDF 格式建立並傳播優異的文件。 開發人員可以結合 DocFX 和 IronPDF PDF 製作功能，製作大量離線就緒的文件，方便存取和分享文件。 這種整合可以強化文件的工作流程，改善專案文件的可讀性和可得性，並增加軟體專案成功的可能性。

開發人員可以透過實施本文的建議並運用 DocFX 和 IronPDF 的功能，優化他們的文件程序、改善團隊合作和溝通，並為使用者和利害關係人提供更好的文件體驗。

$799 Lite 套件包括永久授權、一年的軟體維護，以及升級至函式庫。 IronPDF 提供免費授權，但對再散佈和時間有限制。使用者可在試用期間評估解決方案，而無需看到水印。 有關價格和授權的其他資訊，請參閱 IronPDF 的 授權細節。