DocFx Companion Tools

Markdown dosyalarının ve kaynak dosyalarının bir klasörünü, DocFx Companion Tools'teki yardımcı programlarla DocFX belgelerine dönüştürün. Laurent Ellerbach ve Martin Tirion tarafından oluşturulan paket, dokümantasyon hazırlama, düzenleme, kontrol etme, çevirme ve dönüştürme araçlarını bir araya getiriyor; mevcut sürümü 2.0.0'dır.

DocFxTocGenerator, MD dosyalarını içeren bir klasör yapısını inceler ve dokümantasyon navigasyonu için eşleşen bir içerik tablosu oluşturur. DocLinkChecker, MD dosyaları tarafından referans alınan bağlantıları ve ekleri doğrular, hazırlık ve inceleme sırasında kırık belge referanslarının tanımlanmasına yardımcı olur.

DocLanguageTranslator, MD dosyalarını Azure Bilişsel Hizmetler aracılığıyla otomatik olarak çevirir ve aynı dokümantasyon iş akışına çeviri ekler. DocFxOpenApi, mevcut OpenAPI spesifikasyon dosyalarını DocFX ile uyumlu bir formata dönüştürür, böylece API açıklamaları oluşturulan belgelere dahil edilebilir.

Yardımcı programlar, Markdown içeriğini organize eden, referanslarını kontrol eden, çeviren veya API özelliklerini DocFX projeleriyle birleştiren geliştiricilere, teknik yazarlara ve belge yapımcılarına uygundur. Tipik bir iş akışı, navigasyon oluşturmak, bağlantıları ve ekleri doğrulamak, çevirileri işlemek ve nihai belgeleri oluşturmadan önce OpenAPI materyalini dönüştürmek için dizin düzenini kullanabilir. Paket Windows'ta çalışır ve ücretsiz olarak dağıtılır.