dokumen bisep
1.2.0
Keterangan
Instalasi
Persyaratan
Penggunaan
Berkontribusi
Lisensi
bicep-docs adalah alat baris perintah yang menghasilkan dokumentasi untuk templat Bicep.
minuman keran christosgalano/christosgalano pembuatan bir instal bicep-docs
buka instal github.com/christosgalano/bicep-docs/cmd/bicep-docs@latest
Unduh biner terbaru dari halaman rilis.
Untuk menjalankan bicep-docs, Azure CLI atau Bicep CLI harus diinstal.
| CLI | Versi Minimum yang Diperlukan |
|---|---|
| Biru langit | 2.64.0 |
| bisep | 0.29.0 |
bicep-docs adalah alat baris perintah yang menghasilkan dokumentasi untuk templat Bicep.
Dengan adanya file atau direktori masukan Bicep, ia mem-parsing file dan menghasilkan dokumentasi terkait dalam format penurunan harga.
Ini dapat digunakan untuk membuat dan memperbarui dokumentasi template Bicep Anda secara otomatis.
Jika inputnya berupa direktori, maka untuk setiap main.bicep akan menghasilkan README.md di direktori yang sama. Hal ini terjadi secara rekursif untuk semua subdirektori.
Jika masukannya berupa file Bicep, keluarannya harus berupa file; jika tidak, kesalahan akan dikembalikan.
Nilai default untuk keluarannya adalah README.md , relatif terhadap direktori tempat perintah dijalankan.
PERHATIAN: Jika file Markdown sudah ada, maka akan ditimpa .
Mengenai argumen --include-sections dan --exclude-sections , bagian yang tersedia adalah: description , usage , modules , resources , parameters , udfs , uddts , variables , outputs .
Bagian default yang diurutkan adalah description,usage,modules,resources,parameters,udfs,uddts,variables,outputs . Masukan default untuk --exclude-sections adalah '' . Hal ini memastikan kompatibilitas dengan versi sebelumnya.
Urutan bagian dipatuhi saat menyertakannya.
Ketika mengecualikan bagian, hasilnya akan menjadi bagian default dikurangi yang dikecualikan (misalnya --exclude-sections description,usage akan menyertakan modules,resources,parameters,udfs,uddts,variables,outputs dalam urutan itu).
Kedua argumen tidak dapat diberikan secara bersamaan, kecuali argumen --include-sections sama dengan bagian default (misalnya --include-sections description,usage,modules,resources,parameters,udfs,uddts,variables,outputs ) .
Parsing file Bicep dan buat file Markdown:
bicep-docs --masukan main.bicep --keluaran readme.md
Parsing file Bicep dan buat file README.md di direktori yang sama:
bisep-docs -i main.bicep
Parsing direktori dan hasilkan file README.md untuk setiap file main.bicep dengan keluaran verbose:
bisep-docs -i ./bicep -V
Parsing file Bicep dan hasilkan README.md tidak termasuk bagian yang ditentukan pengguna:
bicep-docs --input main.bicep --exclude-sections udfs,uddts
Parsing file Bicep dan hasilkan README.md yang hanya menyertakan sumber daya dan modul dalam urutan itu:
bicep-docs ---input main.bicep --include-sections resource,modul
Contoh lainnya dapat ditemukan di sini.
Dokumentasi memiliki format berikut:
# nama modul | nama file## Deskripsi...## Penggunaan...## Modultabel modul## Sumber dayatabel sumber daya## Parameterstabil parameter## Tipe Data Buatan Pengguna (UDDT)tabel UDDT## Tabel Fungsi Buatan Pengguna (UDF) dari UDFS## Variabelstabil dari variabel## Keluaranstabil dari keluaran
Alat ini sangat berguna jika Anda mengikuti struktur ini untuk proyek Bicep Anda:
.
├── bicep
│ │
│ ├── modules
│ │ ├── compute
│ │ │ ├── main.bicep
│ │ │ └── README.md
│ │ └── ...
│ │
│ ├── environments
│ │ ├── development
│ │ │ ├── main.bicep
│ │ │ ├── main.bicepparam
│ │ │ └── README.md
│ │ └── ...Informasi tentang berkontribusi pada proyek ini dapat ditemukan di sini.
Proyek ini dilisensikan di bawah Lisensi MIT.
