BookStack

Tumpukan Buku

Sebuah platform untuk menyimpan dan mengatur informasi dan dokumentasi. Detail BookStack dapat ditemukan di situs resminya di https://www.bookstackapp.com/.

• Petunjuk Instalasi

• Dokumentasi

• Contoh Demo

• Masuk Admin

• Tangkapan layar

• Blog Tumpukan Buku

• Daftar Masalah

• Obrolan Perselisihan

• Opsi Dukungan

Definisi Proyek

BookStack adalah platform dokumentasi berpendirian keras yang memberikan pengalaman unik dan menyenangkan. Pengguna baru di sebuah instance harus merasakan pengalaman yang intuitif dan hanya keterampilan pemrosesan kata dasar yang diperlukan untuk terlibat dalam pembuatan konten di BookStack. Platform harus menyediakan fitur-fitur canggih bagi mereka yang menginginkannya tetapi tidak mengganggu pengalaman pengguna inti yang sederhana.

BookStack tidak dirancang sebagai platform yang dapat diperluas untuk digunakan untuk tujuan yang berbeda dengan pernyataan di atas.

Berkenaan dengan filosofi pengembangan, BookStack memiliki pendekatan yang santai, terbuka & positif. Pada akhirnya, ini adalah perangkat lunak gratis yang dikembangkan dan dikelola oleh orang-orang yang menyumbangkan waktu luang mereka.

Anda dapat membaca lebih lanjut tentang proyek ini dan asal usulnya di FAQ kami di sini.

Sponsor Proyek

Di bawah ini adalah sponsor proyek perunggu, perak, dan emas kami. Terima kasih sebesar-besarnya kepada perusahaan-perusahaan ini yang telah mendukung proyek ini. Catatan: Layanan yang terdaftar tidak diuji, diperiksa atau didukung oleh proyek resmi BookStack dengan cara apa pun.

Detail donasi proyek - Halaman Sponsor GitHub - Halaman Ko-fi

Sponsor Emas

Sponsor Perunggu

Pengembangan & Pengujian

Silakan lihat dokumen pengembangan kami untuk detail lengkap mengenai pekerjaan pada kode sumber BookStack.

Jika Anda hanya ingin menyesuaikan atau memperluas instance BookStack Anda sendiri, lihat halaman dokumentasi Peretasan BookStack kami untuk detail tentang berbagai opsi untuk mencapai hal ini tanpa mengubah kode sumber BookStack.

Detail tentang skema versi BookStack dan proses rilis umum dapat ditemukan di sini.

Terjemahan

Terjemahan teks dalam BookStack dikelola melalui proyek BookStack di Crowdin. Beberapa string memiliki variabel yang diawali titik dua seperti :userName . Biarkan nilai-nilai ini apa adanya karena akan diganti pada saat run-time.

Silakan gunakan Crowdin untuk menyumbangkan terjemahan alih-alih membuka permintaan penarikan. Terjemahan dalam basis kode yang berfungsi mungkin sudah ketinggalan zaman, dan penggabungan melalui kode dapat menyebabkan konflik & masalah sinkronisasi. Jika karena alasan tertentu Anda tidak dapat menggunakan Crowdin, silakan membuka terbitan untuk mendiskusikan opsi alternatif.

Jika Anda ingin bahasa baru ditambahkan ke Crowdin agar Anda dapat menyediakan terjemahannya, silakan buka terbitan baru di sini.

Harap diperhatikan, terjemahan di BookStack disediakan ke "Memori Terjemahan Global Crowdin" yang membantu BookStack dan proyek lain dalam menemukan terjemahan. Jika Anda tidak senang berkontribusi dalam hal ini maka tidak disarankan memberikan terjemahan ke BookStack, bahkan secara manual melalui GitHub.

Kontribusi, Masalah & Permintaan Tarik

Jangan ragu untuk membuat masalah untuk meminta fitur baru atau melaporkan bug & masalah. Harap ikuti saja templat yang diberikan saat membuat masalah.

Permintaan penarikan diperkenankan, tetapi kecuali jika perubahannya kecil, mungkin yang terbaik adalah membuka permintaan penarikan lebih awal atau membuat masalah untuk perubahan yang Anda inginkan guna mendiskusikan bagaimana perubahan tersebut akan sesuai dengan proyek dan merencanakan penggabungan. Hanya karena permintaan fitur ada, atau diberi tag, tidak berarti fitur tersebut akan diterima dalam proyek inti.

Permintaan penarikan harus dibuat dari cabang development karena permintaan tersebut akan digabungkan kembali ke dalam development setelah selesai. Harap jangan membuat atau meminta penggabungan ke dalam cabang release karena ini hanya untuk penerbitan rilis. Jika Anda ingin mengubah konten CSS atau JavaScript, silakan edit file sumber yang ada di resources/ . File CSS atau JS apa pun yang ada di public dibuat dari file sumber ini dan oleh karena itu tidak boleh diedit secara langsung.

Kode etik proyek dapat ditemukan di sini.

Keamanan

Informasi keamanan untuk mengelola instance BookStack dapat ditemukan di situs dokumentasi di sini.

Jika Anda ingin diberitahu tentang potensi masalah keamanan baru, Anda dapat mendaftar ke milis keamanan BookStack.

Jika Anda ingin melaporkan masalah keamanan, detailnya dapat ditemukan di sini.

Aksesibilitas

Kami ingin BookStack tetap dapat diakses oleh sebanyak mungkin orang. Kami menargetkan setidaknya standar WCAG 2.1 Level A jika memungkinkan meskipun kami tidak mengujinya secara ketat pada setiap rilis. Jika Anda menemukan masalah aksesibilitas, jangan ragu untuk membuka masalah.

Situs Web, Dokumen & Blog

Situs web yang berisi dokumen & blog proyek dapat ditemukan di BookStackApp/repo situs web.

Lisensi

Sumber BookStack disediakan di bawah Lisensi MIT.

Perpustakaan yang digunakan oleh, dan disertakan dengan, BookStack disediakan di bawah lisensi dan hak cipta mereka sendiri. Lisensi untuk banyak dependensi inti kami dapat ditemukan dalam daftar atribusi di bawah namun ini bukan daftar lengkap semua proyek yang digunakan dalam BookStack.

Atribusi

Orang-orang hebat yang telah bekerja untuk membangun dan meningkatkan BookStack dapat dilihat di sini. Orang-orang hebat yang telah menyediakan terjemahan, baik melalui GitHub atau melalui Crowdin dapat dilihat di sini.

Di bawah ini adalah proyek sumber terbuka hebat yang digunakan untuk membantu membangun BookStack. Catatan: Ini bukan daftar lengkap semua perpustakaan dan proyek yang akan digunakan dalam instance BookStack aktif.

• Laravel- MIT

• TinyMCE - MIT

• Leksikal - MIT

• CodeMirror - MIT

• Dapat diurutkan - MIT

• Ikon Materi Google - Apache-2.0

• daftar tugas penurunan harga dan penurunan harga - MIT dan ISC

• Dompdf - LGPL v2.1

• KnpLabs/tajam - MIT

• WKHTMLtoPDF - LGPL v3.0

• diagrams.net - Persyaratan Versi Tertanam / Proyek Sumber - Apache-2.0

• Perangkat SAML PHP OneLogin - MIT

• Liga/CommonMark - Klausul BSD-3

• Liga/Sistem Terbang - MIT

• Liga/html-ke-penurunan harga - MIT

• Liga/klien oauth2 - MIT

• pragmarx/google2fa - MIT

• Bacon/BaconQrCode - Klausul BSD-2

• phpseclib - MIT

• Jarum jam - MIT

• PHPStan & Larastan - MIT dan MIT

• PHP_CodeSniffer - Klausul 3 BSD

• JakeArchibald/IDB-Keyval - Apache-2.0

Untuk rincian rinci proyek JavaScript & PHP yang diimpor & digunakan melalui NPM & manajer paket komposer, beserta lisensinya, silakan lihat dev/licensing/js-library-licenses.txt dan dev/licensing/php-library-licenses. file txt.