bicep-docs

bicep-docs'i bir Bicep dosyası veya dizini besleyin ve şablonu veya şablonları ayrıştırarak Markdown'da eşleşen belgeler üretir. Bu komut satırı iş akışı, geliştiricilerin şablon referanslarını manuel olarak korumak yerine altyapı kodlarının yanında dokümantasyon oluşturmalarına ve güncellemelerine yardımcı olur.

Bir dizin girdisi için, bicep-docs tekrar tekrar arar ve bulduğu her main.bicep'in yanında bir README.md oluşturur. Tek dosya girişi bir dosyayı çıkış hedefi olarak kullanmalıdır; aksi takdirde komut bir hata bildirir ve varsayılan çıktı komutun çalıştığı dizine göre README.md'dir. Hedef Markdown dosyası zaten varsa, üzerine yazılır.

Oluşturulan sayfalar açıklama, kullanım, modüller, kaynaklar, parametreler, udfs, uddts, değişkenler ve çıktı bölümleri içerebilir. --include-sections seçeneği istenen sırayı korurken, --exclude-sections, adlandırılmış bölümleri varsayılan diziden kaldırır; include o tam varsayılan diziyi belirtmedikçe iki seçenek birleştirilemez. --show-all-decorators bayrağı, izin verilen değerler, minimum ve maksimum limitler ve sayfaları özlü tutmak için varsayılan olarak gizlenen dışa aktarılabilir durum gibi dekoratör kısıtlamaları için tablo sütunları ekler.

Bicep yazarları ve terminal tabanlı geliştirme iş akışları için tasarlanmış, şablonlar değiştikçe yenilenen belgelere ihtiyaç duyan depolara uygundur. bicep-docs, şu anda 1.8.0 sürümünde bulunan Christos Galanopoulos'un Windows Sistem Araçları ücretsiz yazılımıdır ve Azure CLI veya Bicep CLI'nin çalışmasını gerektirir.