docfx C# (Geliştiriciler için Nasıl Çalışır)

DocFX Nasıl Kullanılır

1. .NET SDK 6.0+ kurun
2. PowerShell'i açın.
3. DocFX Kütüphanesini kurmak için scripti tek tek çalıştırın.
4. Kurulumdan sonra JSON dosyasını çalıştırın.
5. Bu, 8080 portunda doküman web sitesini açacaktır.

DocFX'e Giriş

Microsoft, açık kaynak statik site üretici ve dokümantasyon oluşturma aracı DocFX'i yaratmıştır. Markdown dosyaları ve kaynak kodu yardımıyla, geliştiriciler profesyonel görünümlü doküman web siteleri üretebilir. DocFX, çeşitli işaretleme formatları ve programlama dillerini desteklediğinden, birçok projede geniş kapsamda uygulanabilir.

Geliştiriciler, dokümanlarında DocFX'i kullanarak eğitim rehberleri, kavramsal makaleler ve API referansları oluşturabilir. Esnek mimarisi sayesinde, ekipler kişisel gereksinimlerini karşılamak için onu özelleştirebilir ve genişletebilir. DocFX, çapraz referanslama, düzenlenebilir şablonlar ve HTML ile Markdown dahil birçok çıktı formatını destekleme gibi özellikler sunar. DocFX'in iç işleyiş ve metodları üzerine daha ayrıntılı bir açıklama için DocFX Dokümantasyonu'nu ziyaret edin.

DocFX ile Başlarken

DocFX ile Yeni Bir Web Sitesi Oluşturun

Bu aşamada, yerel bilgisayarınızda temel bir dokümantasyon web sitesi oluşturacağız.

• Komut satırı işlemleri hakkında temel bir anlayışa sahip olmak gereklidir.
• .NET SDK 6.0 veya daha yeni bir sürümü gereklidir.

DocFX'in en yeni sürümünü kurmak için, .NET SDK'sının kurulu olduğundan emin olun, ardından bir terminal komut satırı aracını açın ve aşağıdaki komutu yazın:

dotnet tool update -g docfx

Yeni bir doküman seti başlatmak için, şu komutu çalıştırın:

docfx init

docfx init

Tüm yapılandırmaların JSON dosyasını oluşturur. Bu komut yardımıyla, mevcut çalışma dizininde yeni bir DocFX projesi oluşturabilirsiniz. Doküman setini oluşturmak için, şu komutu çalıştırın:

docfx docfx.json --serve

docfx docfx.json --serve

Web sayfası şimdi http://localhost:8080 üzerinde ön izlenebilir.

Değişikliklerinizi kaydedin. DocFX, JSON Yapılandırma dosyası kullanılarak yapılandırılır. Şimdi, bu komutu çalıştırarak web sitesini yeniden oluşturmak ve yerel değişikliklerinizi önizlemek için yeni bir terminal kullanıyoruz:

docfx docfx.json

docfx docfx.json

DocFX'in Özellikleri

DocFX'i IronPDF ile Entegre Etme

DocFX'i IronPDF ile birleştiren geliştiriciler, her iki aracın avantajlarından yararlanarak dokümantasyon süreçlerini iyileştirebilirler. Geliştiriciler, DocFX ile oluşturulan HTML dokümantasyonunu PDF formatına dönüştürmek için IronPDF kullanarak, cihazlarda tutarlı renderlama, çevrimdışı hazır dokümantasyon oluşturma ve paylaşımı ve dağıtımı daha kolay hale getirebilirler. IronPDF hakkında daha fazla bilgi için lütfen IronPDF Dokümantasyonu bölümüne bakın.

IronPDF'yi Yükleyin

• Visual Studio projesini başlatın.
• "Araçlar" > "NuGet Paket Yöneticisi" > "Paket Yöneticisi Konsolu"nu seçin.
• Visual Studio Paket Yöneticisi Konsolu'nda, aşağıdaki komutu yazın (bu satırı doğru paket kurulum komutuna dönüştürün):

Install-Package IronPdf

• Alternatif olarak, Çözümler için NuGet Paket Yöneticisi'ni kullanarak IronPDF'i yükleyebilirsiniz.

• Arama sonuçlarından IronPDF paketini seçip, ardından "Yükle" seçeneğine tıklayabilirsiniz. Visual Studio, indirme ve kurulum işlemlerini sizin adınıza halledecektir.

  

• NuGet, projeniz için gereken tüm bağımlılıklarla birlikte IronPDF paketini yükleyecektir.
• Kurulumdan sonra IronPDF projenizde kullanılabilir.

Mantığın Uygulanması

Entegrasyon sürecinde aşağıdaki mantık bulunur:

1. DocFX ile Dokümantasyon Oluşturun: Başlamak için DocFX kullanarak dokümantasyonunuzu oluşturun. Bu, kaynak kod ve projenizin Markdown dosyaları üzerinde DocFX derleme sürecini gerçekleştirmeyi içerir ve HTML dokümantasyonu oluşturur.
2. HTML Dokümantasyonunu PDF'ye Dönüştürmek için IronPDF Kullanın: HTML dokümantasyonu oluşturulduktan sonra, bunu programatik olarak PDF formatına dönüştürmek için IronPDF kullanın. IronPDF'in HTML'den PDF'ye dönüşüm özelliklerini kullanarak HTML metnini yazdırılabilir PDF belgelerine dönüştürmek kolaydır.
3. Dönüşüm Sürecini Otomatikleştirin: İş akışını optimize etmek için C# kodu veya komut dosyaları kullanarak dönüşüm sürecini otomatikleştirin. Bu, manuel müdahale gerektirmeden dokümantasyonun kolayca güncellenip yeniden oluşturulabilmesini garanti eder.

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

Kod örneği hakkında daha fazla bilgi için bu örnek kullanım kılavuzuna bakın. Çalıştırma çıktısı aşağıda gösterilmektedir:

Sonuç

Son olarak, geliştiriciler C# içinde DocFX'i IronPDF ile entegre ederek, PDF formatında mükemmel dokümantasyon oluşturmak ve yaymak için güçlü bir seçeneğe sahip. Geliştiriciler, dokümantasyon oluşturmak için DocFX ve IronPDF'in PDF üretim yeteneklerini bir arada kullanarak, erişimi kolay ve paylaşılabilir, kapsamlı, çevrimdışı hazır dokümantasyon oluşturabilirler. Bu entegrasyon dokümantasyon iş akışını iyileştirir, proje dokümantasyonunun okunabilirliğini ve erişilebilirliğini artırır ve yazılım projesi başarısının olasılığını artırır.

Geliştiriciler, bu makaledeki önerileri uygulayarak ve DocFX ve IronPDF'in yeteneklerinden yararlanarak dokümantasyon süreçlerini optimize edebilir, takım çalışmasını ve iletişimi iyileştirebilir, kullanıcılar ve paydaşlar için daha iyi dokümantasyon deneyimleri sunabilirler.

$799 Lite paketi bir süresiz lisans, bir yıllık yazılım bakımı ve kütüphaneye bir yükselteme içerir. IronPDF, yeniden dağıtım ve zaman kısıtlamaları ile ücretsiz lisanslama sunar. Kullanıcılar, çözümü deneme süresi boyunca filigran görmeden değerlendirebilirler. Fiyat ve lisans hakkında ek bilgi için lütfen IronPDF'in lisanslama detayları kısmına bakın.