SassDoc

SassDoc terinspirasi dan model setelah JSDoc .
Sama seperti generator dokumentasi lain, SassDoc bekerja dengan meraih komentar dari file SASS / SCSS dan menciptakan indah terorganisir halaman, dokumentasi HTML dari mereka.
Semua konten yang terstruktur dengan baik menjadi beberapa bagian untuk menangani fungsi, variabel, dan mixin. Referensi untuk potongan kode asli dan kode sumber penyorotan juga didukung.
Selain SassDoc tema standar, template lain juga tersedia.
Untuk menggunakan SassDoc silahkan cek dokumentasinya pertama untuk informasi yang tepat tentang bagaimana untuk memformat komentar kode sumber SASS / SCSS sehingga mereka dapat dideteksi dan digunakan oleh mesin SassDoc itu.

Apa yang baru dalam rilis ini:

• Upgrade ke Babel 5.0
• Pastikan nama default tema yang dicatat dengan benar
• Beberapa dependensi update
• Beralih ke ESLint

Apa yang baru dalam versi 2.1.1:

• Perbaharui versi sass-convert untuk mencegah 6to5- yang masalah runtime yang dijelaskan dalam.

Apa yang baru dalam versi 2.0.0:

• Seluruh API telah sepenuhnya refactored di ES6
• $ tanda kini opsional ketika mendefinisikan nama dalamparameter penjelasan
• Sekarang mungkin untuk menggunakan pola pengecualian file / folder
• Sekarang mungkin untuk pipa SassDoc ke stdin
• - pilihan debug telah ditambahkan ke output informasi tentang pengaturan arus
• Tema sebenarnya sekarang memiliki konfigurasi googleAnalytics menerima Google Analytics kunci pelacakan
• Tema sebenarnya sekarang memiliki konfigurasi trackingCode menerima sebuah potongan HTML sewenang-wenang untuk dimasukkan sebelum & # x3c; / body & # x3e;
• content penjelasan kini benar output dalam tema default
• Reset theme sekarang menampilkan jenis serta nama ketika silang semuanya (persyaratan, dan seterusnya ...)
• Pesan kesalahan sekarang harus lebih eksplisit, memberikan nama file dan baris
• - opsi mengurai telah ditambahkan ke output data parsing mentah sebagai JSON dari CLI

Apa yang baru dalam versi 1.10.6.

• Pastikan jenis yang tepat memeriksa penjelasansee

Apa yang baru dalam versi 1.10.3.

• requires Dicegah mengisi otomatis ketergantungan dua kali

Apa yang baru di versi 1.8.0:

• Ditambahkan kemampuan untuk menambahkan penjelasan Anda sendiri untuk tema Anda
• Tetap masalah dengan barang yang dipesan secara acak

Apa yang baru dalam versi 1.6.0:

• Ditambahkan Generator Yeoman untuk membuatnya lebih mudah untuk membangun tema.
• Ditambahkan dukungan untuk file konfigurasi YAML; Nama file konfigurasi default masih melihat, baik sebagai .json, .yaml atau .yml.
• Ditambahkan pesan untuk memperingatkan terhadap bergantung pada nama file konfigurasi default (lihat. {Json, YAML, yml}) karena akan istirahat di versi 2.0.0 mendukung .sassdocrc (yang akan mendukung kedua format yang sekaligus sementara menjadi lebih semantik, kurang membingungkan dan kurang cenderung bertentangan dengan proyek lain).
• Tetap masalah ketika nilai item variabel 'mengandung titik koma.
• Peningkatan tema ringan (beralih sidebar yang lebih baik dengan negara-negara yang tersimpan di localStorage, beralih baik kode, struktur JavaScript yang lebih baik, dan kinerja yang lebih baik).

Apa yang baru dalam versi 1.5.2:

• Ditambahkan tipe implisit untuk penampung yang diperlukan

Apa yang baru dalam versi 1.4.1:.

• Tetap tes patah

Apa yang baru dalam versi 1.3.2:.

• Tetap tes patah

Apa yang baru dalam versi 1.1.6:

• backport, tetap ditemukan di-dengan path absolut.

Persyaratan :

• Node.js