Lewati ke konten utama

59 dokumentasi memiliki tag dengan "doc-gen"

Lihat Semua Tag

Contoh

Contoh: doc-gen structure analyze

Contoh

Contoh: doc-gen structure generate

Contoh

Contoh: doc-gen structure print

Contributing

Siapkan contribution untuk Doc Gen yang focused, tested, documented, dan aman.

Development Setup

Install Doc Gen dalam editable mode dan konfigurasi pre-commit contributor workflow.

Docker

Pull image production Doc Gen dengan tag stabil immutable atau bergerak dan jalankan CLI di dalam container.

FAQ

FAQ: doc-gen init

FAQ

FAQ: doc-gen structure analyze

FAQ

FAQ: doc-gen structure generate

FAQ

FAQ: doc-gen structure print

Konsep

Pahami cara Doc Gen menentukan detail struktur, menyesuaikan pemindaian, dan melindungi file proyek.

Masalah Umum

Diagnosis kegagalan konfigurasi, target, lingkungan, dan alur kerja.

Opsi

Opsi: doc-gen init

Opsi

Opsi: doc-gen structure analyze

Opsi

Opsi: doc-gen structure generate

Opsi

Opsi: doc-gen structure print

Output

Output: doc-gen structure analyze

Output

Output: doc-gen structure generate

Output

Output: doc-gen structure print

Persyaratan

Target dapat ditulis. Kompatibilitas package Python 3.9+; runtime standar 3.14. Tinjau .config/doc_gen sebelum --force.

Persyaratan

Target dapat dibaca. Akses untuk inspect entry. Ignore rule sesuai generated directory.

Persyaratan

Target dapat dibaca. Output parent dapat ditulis untuk live generation. Output tidak menunjuk dokumentasi yang tidak terkait.

Persyaratan

Target dapat dibaca. Terminal dapat menampilkan tree. Profile/depth sesuai ukuran repository.

Ringkasan

Pahami responsibility dan execution flow.

Ringkasan

Membuat file konfigurasi Doc Gen milik proyek.

Ringkasan

Memeriksa karakteristik repository dan setting struktur tanpa menulis dokumentasi proyek.

Ringkasan

Memindai repository, merender tree sebagai Markdown, dan menulis hanya output document hasil resolution.

Ringkasan

Memindai dan merender project tree langsung ke terminal tanpa membuat Markdown document.

Ringkasan

Pahami file konfigurasi, urutan prioritas, dan bagian yang aktif.

Ringkasan

Siapkan, uji, dan kembangkan proyek tanpa melemahkan batas keamanan.

Ringkasan

Instal CLI, inisialisasi konfigurasi proyek, dan jalankan alur kerja pertama dengan aman.

Ringkasan

Referensi cepat CLI, path, option, dan safety.

Ringkasan

Diagnosis kegagalan konfigurasi, target, lingkungan, dan alur kerja.

Ringkasan

Pilih workflow berdasarkan target dan efek samping.

Sintaks

Sintaks: doc-gen structure analyze

Sintaks

Sintaks: doc-gen structure generate

Sintaks

Sintaks: doc-gen structure print