NextBook

NextBook adalah cara cepat dan mudah untuk membuat buku teknis atau dokumentasi yang mendukung standar modern dan berjalan dengan cepat. Ini bekerja dengan menyusun markdown dan mdx ke halaman statis. Dengan cara ini, render konten pertama pada perangkat pengguna hampir instan.

NextBook membuat penulisan dokumen teknis bodoh sambil menjaga fitur fitur minim tetapi terbuka untuk ekstensi lebih lanjut.

Fitur Utama?

• ? Tampan, sederhana dan mudah dibaca berdasarkan tailwindcs termasuk mode dark dan tata letak auto-centered ,
• ? SEO yang bagus di luar kotak,
• Mobile & Printer Friendly,
• Aplikasi Halaman Tunggal dengan Pra-Fetching,
• ? Pembuatan konten yang mudah dengan penurunan harga dan dukungan MDX,
• Sesuatu yang lebih dari apa yang ditawarkan kode berpagar dasar. Seperti sorotan baris, menautkan ke sumber dan menyalin ke clipboard,
• ? Alur kerja dan kolaborasi git yang akrab,
• ⌨︎ Pintasan keyboard untuk tindakan yang sering digunakan (perubahan tema, navigasi halaman),
• ? Daftar Isi Opsional dalam Halaman dengan Scroolspy,
• © Anda memiliki data, kode adalah data . Berkomitmen untuk repositori dan melihat menghasilkan bentuk yang paling sederhana,
• ? Cepat untuk memulai, hanya satu perintah untuk Up & Running secara lokal,
• ? Satu klik (atau dorong) penyebaran,
• ? Fitur dinamis tanpa batas dapat ditambahkan dengan MDX,
• ⚙︎ Basis kode yang dapat disesuaikan, dapat diperluas dan sederhana,
• ❤ Dibangun di atas sumber terbuka,
• ? Dan banyak lagi detail kecil ...

Dengan keunggulan Next.js dan bereaksi sesuatu yang mewah (penilaian, level switching ...) dapat ditambahkan di sepanjang jalan.

Apa yang baru di NextBook 3.0?

Rilis ini berisi peningkatan kecepatan besar dan perubahan yang tidak sesuai . Sebagian besar berasal dari MDX2 menghapus beberapa fungsi dan perpustakaan lama lainnya masih belum mendukung modul ES.

• Bermigrasi ke next-mdx-remote v.4 yang sekarang menggunakan MDX2 . Ini memiliki beberapa peningkatan kecepatan dan pemeriksaan sintaks MDX yang lebih ketat. Lihat MDX2
• Mengganti beberapa plugin markdown yang tidak kompatibel dengan mitra MDX. Ini adalah:
  • Subskrip: Was ~ , menjadi tag <sub> .
  • Superscript: Was ^ , menjadi tag <sup> .
  • Mark (Higlight): Was == , menjadi tag <mark> .
  • Sintaks yang diubah untuk komponen Accordion dan Tabs . Lihat dokumentasi terkait.
• Fungsionalitas yang dihapus
  • Kode indentasi. Ini dihapus dari MDX2 . Gunakan cara lain untuk mendefinisikan blok kode berpagar.
  • Menghubungkan dengan braket sudut: Ini telah dihapus dari MDX2 . Gunakan cara lain untuk mendefinisikan tautan.

Apa yang baru di NextBook 2.0?

• Dukungan untuk beberapa buku dalam satu proyek.
• Desain berdasarkan tailwindcss.
• Konten Markdown sekarang dimuat dengan MDX-Remote Next. Ini berarti konten sekarang dipisahkan dari halaman yang dialihkan.
• Tata letak yang berpusat pada otomatis pada resolusi besar yang mengarah ke satu opsi konfigurasi yang lebih sedikit.
• 40% ukuran bundel yang lebih kecil.
• Bilah navigasi.
• UI seluler halus.
• Lebih sedikit kode (−4.000 LOC).

Memulai

1. Menginstal node sebelumnya, bootstrap proyek baru dengan npx create-next-app my-awesome-book -e https://github.com/amiroff/NextBook
2. Jalankan npm run dev:watch dan buka http: // localhost: 3000/
3. Periksa dokumentasi untuk melihat apa yang mungkin dengan NextBook.
4. Buat Konten Markdown atau MDX Anda di Folder content . Halaman harus auto-refresh saat Anda memodifikasi konten Markdown.
5. Perbarui config/config.json dengan daftar konten dan informasi lainnya.
6. Perbarui pages/index.jsx sesuai dengan kebutuhan Anda sebagai halaman pendaratan mandiri atau sebagai pengalihan konten.
7. Menyebarkan Respositori atau Ekspor Anda ( npm run export ) dan Salin Konten Anda ke Penyedia Hosting Statis seperti Vercel, Netlify, Github Pages atau Google Cloud.
8. Selamat bersenang-senang! ?

Ini seharusnya cukup untuk memiliki halaman/buku dokumentasi yang dihasilkan secara statis.