bicep-docs

Feed bicep-docs a Bicep file o directory e analizza il modello o i modelli, producendo documentazione corrispondente in Markdown. Questo flusso di lavoro di riga di comando aiuta gli sviluppatori a creare e aggiornare la documentazione accanto al loro codice infrastrutturale invece di mantenere i riferimenti dei modelli manualmente.

Per un ingresso directory, bicep-docs cerca in modo ricorsivo e crea un README.md accanto a ogni principale. che trova. Un ingresso singolo file deve utilizzare un file come target di output; altrimenti il comando segnala un errore, e l'output predefinito è README.md rispetto alla directory in cui viene eseguito il comando. Se il file di destinazione Markdown esiste già, è sovrascritto.

Le pagine generate possono contenere sezioni di descrizione, utilizzo, moduli, risorse, parametri, udfs, uddts, variabili e uscite. L'opzione --include-sezioni conserva l'ordine richiesto, mentre --exclude-sezioni rimuove le sezioni nominate dalla sequenza predefinita; le due opzioni non possono essere combinate a meno che l'inclusione specifichi quella sequenza predefinita completa. La bandiera --show-all-decorators aggiunge colonne da tavolo per vincoli decoratori come valori consentiti, limiti minimi e massimi, e stato esportabile, che sono nascosti per impostazione predefinita per mantenere le pagine concise.

Progettato per gli autori di Bicep e i flussi di lavoro di sviluppo basati sul terminale, si adatta a repository che hanno bisogno di documentazione rinfrescata come modelli di cambiamento. bicep-docs è Windows System Tools freeware di Christos Galanopoulos, attualmente alla versione 1.8.0, e richiede sia il CLI Azure o il CLI Bicep da eseguire.