fluid styleguide

Fluid StyleGuide - Living StyleGuide untuk Typo3

Fluid StyleGuide adalah alat kolaborasi desain untuk proyek TYPO3. Ini mendukung pengembang Frontend dalam menciptakan komponen yang dapat digunakan kembali dan mendorong komunikasi yang efektif di semua pemangku kepentingan proyek.

Coba demo langsung

Kelompok target

Fluid StyleGuide dapat menjadi alat yang berguna untuk semua pemangku kepentingan proyek:

• Desainer dan pengembang frontend dapat meningkatkan pengembangan mereka dan alur kerja QA
• Frontend, backend dan integrasi mendiskusikan dan mengoordinasikan struktur data dan antarmuka antara tumpukan
• Manajer proyek dan pemilik produk melihat keadaan komponen proyek saat ini
• Klien mendapatkan lebih banyak transparansi dari status proyek

Fitur

• Visualisasi komponen proyek
• pengembangan komponen yang terisolasi
• pengujian responsif
• Dokumentasi Komponen Terpadu
• Dukungan untuk banyak bahasa
• Dukungan untuk aset frontend yang disediakan oleh kolektor aset Typo3
• menunjukkan masalah kualitas kode berdasarkan cairan-komponen-linter
• Kulit dasar agar sesuai dengan warna merek proyek
• unduh zip
• Konfigurasi yang mudah dan fleksibel melalui file YAML
• Pengeditan langsung data contoh [beta]

Memulai

Cukup ikuti langkah -langkah sederhana ini untuk memulai dengan styleGuide:

1. Pasang cairan styleGuide

   Via Composer:

    composer require sitegeist/fluid-styleguide
   

   atau unduh ekstensi dari ter:

   TER: Fluid_styleguide

2. Uji cairan cairan dengan komponen demo

   Cukup buka halaman /fluid-styleguide/ di instalasi TYPO3 Anda:

    https://my-domain.tld/fluid-styleguide/
   

Untuk menambahkan komponen Anda sendiri ke styleGuide, cukup ikuti langkah -langkah tambahan ini:

3. Konfigurasikan komponen fluida

   Pastikan untuk menentukan komponen namespace di ext_localconf.php Anda:

    $ GLOBALS [ ' TYPO3_CONF_VARS ' ][ ' EXTCONF ' ][ ' fluid_components ' ][ ' namespaces ' ][ ' VENDOR \ MyExtension \ Components ' ] =
        TYPO3  CMS  Core  Utility ExtensionManagementUtility:: extPath ( ' my_extension ' , ' Resources/Private/Components ' );

   Gunakan nama vendor Anda sendiri untuk VENDOR , nama ekstensi untuk MyExtension , dan kunci ekstensi untuk my_extension .

4. Konfigurasikan aset frontend Anda

   Buat file konfigurasi styleGuide di ekstensi atau sitepackage Anda.

   Konfigurasi/yaml/fluidstyleguide.yaml:

    FluidStyleguide :
       ComponentAssets :
           Packages :
               ' VendorMyExtensionComponents ' :
                   Css :
                       - ' EXT:my_extension/Resources/Public/Css/Main.min.css '
                   Javascript :
                       - ' EXT:my_extension/Resources/Public/Javascript/Main.min.js '

   Gunakan nama vendor Anda sendiri untuk VENDOR , nama ekstensi untuk MyExtension , dan kunci ekstensi untuk my_extension . Sesuaikan jalur ke aset sesuai dengan struktur direktori Anda.

5. Mulailah membangun komponen Anda sendiri menggunakan komponen cairan dan file fixture

Jika Anda memiliki pertanyaan, perlu dukungan atau ingin membahas komponen di Typo3, jangan ragu untuk bergabung dengan #ext-fluid_components.

Dokumentasi

• Komponen bangunan dengan cairan styleguide
• Referensi Konfigurasi StyleGuide