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

如何使用 DocFX

1. 安裝 .NET SDK 6.0+
2. 打開 PowerShell。
3. 一個接一個地運行腳本以安裝 DocFX 程式庫。
4. 安裝後，運行 JSON 檔案。
5. 這會在埠 8080 上打開文件網站。

DocFX 介紹

Microsoft 創建了開源的靜態網站生成器和文件生成工具 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 創建您的文件。 這需要執行 DocFX 構建過程以生成項目的 HTML 文件。
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 的授權詳情。