docs.surrealdb.com

adalah awan terbaik
Database untuk aplikasi besok

Berkembang lebih mudah. Membangun lebih cepat. Skala lebih cepat.

Dokumentasi untuk SurealDB, dibangun menggunakan Astro.

Jika Anda ingin berkontribusi, maka silakan baca pedoman yang berkontribusi.

Memulai dengan SurrealDB

Kunjungi SurealDB.com/docs untuk memulai dengan SurrealDB.

Pelajari SurrealDB

• Universitas Surrealdb: https://surrealdb.com/learn/fundamentals
• Renaissance Surreal Aeon (Buku Interatif): https://surrealdb.com/learn/book
• Dokumentasi: https://surrealdb.com/docs

Berkontribusi pada dokumentasi

Silakan lihat pedoman yang berkontribusi.

Masalah pertama yang bagus

Kami memiliki daftar masalah pertama yang baik yang berisi bug yang memiliki ruang lingkup yang relatif terbatas. Ini adalah tempat yang tepat untuk memulai, mendapatkan pengalaman, dan terbiasa dengan proses kontribusi kami.

Instalasi

Untuk memulai dengan berkontribusi pada dokumentasi SurealDB, pertama -tama instal paket yang diperlukan menggunakan perintah berikut.

Proyek ini menggunakan BUN sebagai manajer paket kami. Jika Anda belum menginstal BUN, maka silakan lihat panduan instalasi untuk sistem operasi Anda. Ini juga membutuhkan node.js v20.0.0 atau lebih tinggi.

bun i 

Perkembangan

Perintah berikut memulai server pengembangan lokal dan membuka jendela browser. Sebagian besar perubahan tercermin secara langsung tanpa harus memulai kembali server.

 bun dev

Bangunan

Perintah berikut membangun dan menghasilkan konten statis ke dalam direktori build , dan kemudian dapat dilayani menggunakan layanan hosting konten statis apa pun.

 bun run build

Struktur file

Untuk berkontribusi pada dokumentasi, sebagian besar perubahan Anda akan dilakukan pada direktori src/content . Setiap bagian dokumentasi memiliki subdirektori sendiri, dan setiap halaman adalah file MDX.

src/
    assets/
    components/
    content/
        doc-surrealdb/
        doc-surrealql/
        doc-surrealist/
        ...
    layouts/
    pages/
    styles/
    util/ 

Berbaris

Untuk memastikan dokumentasinya konsisten dan mengikuti panduan gaya kami, kami menggunakan make qc untuk memeriksa kesalahan serat. Anda juga dapat menggunakan make qa untuk secara otomatis memperbaiki sebagian besar kesalahan.

Berikut adalah perintah untuk beberapa perintah umum yang mungkin perlu Anda gunakan.

• make install - instal dependensi, pertama kali atau saat mereka berubah
• make dev - Jalankan Server Pengembangan
• make build - Bangun Situs Web
• make preview - pratinjau bangunan yang Anda buat
• make qc - Periksa Kualitas Kode (FMT + LINT)
• make qa - Terapkan Saran Kualitas Kode Aman
• make qau - Terapkan Saran Kualitas Kode Aman