Lewati ke konten
Ikhtisar dokumentasi
Dokumentasi Pratinjau

Dokumentasi classroom-themekit

Peta isi, empat aturan pokok, dan urutan baca yang disarankan.

Apa ini

Theme kit HTML/CSS/JS untuk seluruh area dalam aplikasi classroom. Kit ini memindahkan sistem desain aplikasi aslinya (Next.js + React + Tailwind) menjadi berkas statis yang bisa dipakai halaman mana pun.

Untuk siapa

Siapa pun yang membangun halaman di dalam aplikasi: halaman baru, prototipe, halaman statis, atau halaman lama yang sedang dipindahkan. Satu-satunya cara agar dua halaman terlihat satu keluarga adalah memakai kit ini, bukan menyalin gayanya.

Peta isi

HalamanIsinyaKapan dibaca
Mulai cepatLima menit sampai halaman pertama jalanHari pertama
PemasanganBerkas, urutan pemuatan, cara memasang di proyek lamaSebelum menempel ke proyek nyata
Standar desainAturan mengikat: warna, jarak, huruf, keadaan, gerakSebelum menulis tampilan apa pun
Token & variabelDaftar lengkap token beserta nilainyaSaat butuh nilai pasti
Aturan komponenPenamaan, struktur, larangan, perilaku JSSaat menambah atau mengubah komponen
AksesibilitasSasaran WCAG, kontras terukur, pola ARIASaat menyentuh interaksi
Migrasi dari TailwindPeta kelas Tailwind lama ke kelas ck-Saat memindahkan halaman lama
Menambah komponenAlur kerja dan penjaga otomatisSebelum mengirim perubahan

Empat aturan pokok

Kalau hanya satu halaman dokumentasi yang dibaca, baca ini.

1
Satu sumber nilai

Semua warna, ukuran, radius, dan bayangan datang dari tokens/tokens.css. Tidak ada angka atau warna yang ditulis langsung di komponen.

2
Semua berawalan ck-

Kit ini hidup berdampingan dengan gaya lama tanpa bertabrakan. Tidak ada selektor elemen telanjang, tidak ada !important.

3
Tanpa langkah build

Dua berkas, satu tag. Tidak ada Tailwind, tidak ada bundler, tidak ada dependensi. Yang bisa dibuka di peramban adalah yang dikirim.

4
Aturan dijaga mesin

tools/check.py menolak perubahan yang melanggar aturan di atas. Aturan yang tidak dijaga mesin akan hilang dalam sebulan.

Batas lingkup
Halaman pemasaran, halaman hukum, dan seluruh logika aplikasi (API, penyimpanan, otentikasi) di luar kit ini. Kit hanya lapisan tampilan area dalam aplikasi.

Alur baca yang disarankan

  1. 1
    Mulai cepat
    Buat satu halaman kosong dan pasang kit.
  2. 2
    Standar desain
    Pahami aturan sebelum menulis tampilan.
  3. 3
    Pratinjau komponen
    Cari komponen yang sudah ada sebelum membuat yang baru.
  4. 4
    Kontribusi
    Kirim perubahan lewat penjaga otomatis.

Versi & status

Versi kit1.0.0
Sumber sistem asliarsasatria/classroom @ 18f41f9
Cakupaninner-classroom (bukan landing page)
Token138, terang + gelap
Halaman komponen42
Dependensi runtime0
classroom-themekitdokumentasi