just the docs

Hanya Dokumennya

Tema Jekyll yang modern, sangat dapat disesuaikan, dan responsif untuk dokumentasi dengan pencarian bawaan.
Mudah dihosting di Halaman GitHub dengan sedikit ketergantungan.

Lihat aksinya!

Panduan video berbagai fitur Just the Docs

hanya-the-docs-features-walkthrough.mp4

Instalasi

Gunakan templatnya

Templat Just the Docs menyediakan cara termudah, tercepat, dan termudah untuk membuat situs web baru yang menggunakan tema Just the Docs. Untuk mulai membuat situs, cukup klik "gunakan template"!

Catatan: Untuk menggunakan tema ini, Anda tidak perlu mengkloning atau membagi repo Just the Docs! Anda sebaiknya melakukan hal tersebut hanya jika Anda ingin menelusuri dokumen tema secara lokal, berkontribusi pada pengembangan tema, atau mengembangkan tema baru berdasarkan Just the Docs.

Anda dapat dengan mudah mengatur situs yang dibuat oleh templat untuk dipublikasikan di Halaman GitHub – file README templat menjelaskan cara melakukannya, beserta detail lainnya.

Jika Jekyll terinstal di komputer Anda, Anda juga dapat membuat dan melihat pratinjau situs yang dibuat secara lokal . Hal ini memungkinkan Anda menguji perubahan sebelum menerapkannya, dan menghindari menunggu Halaman GitHub. ¹ Dan Anda akan dapat menerapkan bangunan lokal Anda ke platform yang berbeda dari Halaman GitHub.

Lebih khusus lagi, situs yang dibuat:

• menggunakan pendekatan berbasis permata, yaitu menggunakan Gemfile dan memuat permata just-the-docs
• menggunakan alur kerja Halaman GitHub/Tindakan untuk membangun dan mempublikasikan situs di Halaman GitHub

Selain itu, Anda bebas menyesuaikan situs yang Anda buat dengan template, sesuka Anda. Anda dapat dengan mudah mengubah versi just-the-docs dan Jekyll yang digunakannya, serta menambahkan plugin lebih lanjut.

Gunakan RubyGems

Alternatifnya, Anda dapat menginstal tema sebagai Ruby Gem, tanpa membuat situs baru.

Tambahkan baris ini ke Gemfile situs Jekyll Anda :

 gem "just-the-docs"

Dan tambahkan baris ini ke _config.yml situs Jekyll Anda:

 theme : just-the-docs

Dan kemudian jalankan:

 $ bundle

Atau instal sendiri sebagai:

 $ gem install just-the-docs

Alternatifnya, Anda dapat menjalankannya di dalam Docker sambil mengembangkan situs Anda

 $ docker-compose up

Penggunaan

Lihat dokumentasi untuk informasi penggunaan.

Berkontribusi

Laporan bug, proposal fitur baru, dan permintaan penarikan diterima di GitHub di https://github.com/just-the-docs/just-the-docs. Proyek ini dimaksudkan untuk menjadi ruang kolaborasi yang aman dan ramah, dan kontributor diharapkan mematuhi kode etik Perjanjian Kontributor.

Mengirimkan perubahan kode:

• Kirimkan Masalah yang memotivasi perubahan, menggunakan templat yang sesuai
• Diskusikan perubahan yang diusulkan dengan pengguna lain dan pengelola
• Buka Permintaan Tarik
• Pastikan semua tes CI lulus
• Berikan instruksi untuk memeriksa efek perubahan
• Tunggu peninjauan kode

Prinsip desain dan pengembangan tema ini:

1. Ketergantungan sesedikit mungkin
2. Tidak diperlukan skrip build
3. Pengalaman seluler kelas satu
4. Jadikan kontennya bersinar

Perkembangan

Untuk mengatur lingkungan Anda untuk mengembangkan tema ini: fork repo ini, jalankan bundle install dari direktori root.

Konfigurasi devcontainer modern untuk VSCode disertakan.

Tema Anda diatur seperti situs Jekyll pada umumnya! Untuk menguji tema Anda, jalankan bundle exec jekyll serve dan buka browser Anda di http://localhost:4000 . Ini memulai server Jekyll menggunakan tema Anda. Tambahkan halaman, dokumen, data, dll. seperti biasa untuk menguji konten tema Anda. Saat Anda melakukan modifikasi pada tema dan konten Anda, situs Anda akan dibuat ulang dan Anda akan melihat perubahannya di browser setelah penyegaran, seperti biasa.

Saat tema ini dirilis, hanya file dalam _layouts , _includes , dan _sass yang dilacak dengan Git yang akan disertakan dalam permata.

Lisensi

Tema ini tersedia sebagai open source di bawah ketentuan Lisensi MIT.

Catatan kaki

1. Diperlukan waktu hingga 10 menit agar perubahan pada situs Anda dipublikasikan setelah Anda memasukkan perubahan ke GitHub. ↩