Unduhan gumdrop - Unduhan kode sumber gumdrop

gumdrop

Kategori lainnya

v2.2.0

Unduh

Gula permen karet

Skrip tanpa konfigurasi untuk menampilkan dokumen Markdown sebagai halaman HTML statis

Gumdrop dirancang agar mudah digunakan, skrip mandiri yang dapat menghasilkan situs web dan dokumentasi yang ditulis dalam Markdown. Ini secara dinamis memuat semua dependensinya dari CDN (termasuk parser Markdown) dan tidak memerlukan konfigurasi atau inisialisasi apa pun.

Instalasi

Gumdrop tidak memerlukan instalasi Anda hanya perlu memuatnya ke dalam dokumen HTML dengan tag script .

 < script src =" https://cdn.jsdelivr.net/npm/gumdrop@4 " > </ script >

Penggunaan

Untuk membuat situs web statis dengan Markdown, yang perlu Anda lakukan hanyalah membuat templat HTML ( index.html ) di server file Anda dan menambahkan Gumdrop sebagai file skrip eksternal.

 < main > </ main >
< script src =" path/to/gumdrop.js " >

Perlu diketahui, Anda harus menyajikan file Anda melalui protokol http / https , karena protokol file tidak mendukung permintaan pengambilan.

File penurunan harga di folder pages dapat dimuat. Gumdrop mengamati fragmen hash dari URL dan memuat file Markdown yang sesuai dari folder pages . File Markdown yang diurai akan dirender di node HTML <main> jika ada, sebaliknya di body . File default yang dimuat jika tidak ada file yang ditentukan adalah pages/index.md . Untuk membuat link ke file lain di folder pages cukup buat link dengan namanya diawali #!/ .

 [ Link to about.md ] ( #!/about )

Sumber daya statis (misalnya gambar) dapat dimuat dari folder mana pun yang dilayani oleh server file Anda, jalurnya relatif terhadap index.html . Halaman kesalahan untuk berbagai kesalahan HTTP dapat ditempatkan di folder errors . Setiap file harus diberi nama sesuai dengan kode kesalahan HTTP yang diwakilinya (misalnya errors/404.md ).

Data tambahan dapat ditentukan untuk dokumen Anda di YAML Front Matter. Anda dapat mengakses data ini di dokumen Markdown mana pun dengan templat kumis.

Anda juga dapat menggunakan file terpisah untuk menyimpan data dan menautkan file sumber daya ini ke dokumen di bagian depan. File sumber daya dapat menggunakan tipe YAML (default), JSON, atau Markdown. Nilai apa pun di bagian depan dokumen yang dianotasi dengan tipe !file dianggap sebagai sumber daya file. Jalur file yang dimulai dengan / di depan relatif terhadap index.html , jika di depan / tidak ada maka folder data diasumsikan sebagai lokasi sumber daya. Jika tidak ada jenis file (ekstensi) yang diberikan maka ekstensi .yaml diasumsikan. Untuk file sumber daya .md nilai yang dikembalikan akan menjadi dokumen Markdown yang dirender.

 # data/todo.yaml

todos :
  - title : First todo
    text : Complete your first assignment
    completed : true
  - title : YAML
    text : Learn more about YAML Front Matters
    completed : false

 ---
todos: !file todo.yaml
---
{{#todos}}
- **{{title}}**: {{text}} {{#completed}}(✔){{/completed}}
{{/todos}}

Fitur

Konfigurasi nol, tidak diperlukan inisialisasi
Tidak ada kode sisi server, hanya memerlukan server file statis
Tidak ada langkah pembuatan/pembuatan, hanya file yang Anda sajikan
Fitur Penurunan Harga Ekstra melalui ExtraMark
Navigasi berdasarkan permintaan pengambilan
Caching file lokal untuk waktu muat lebih cepat
Data tambahan di materi depan dan file data ditangani oleh templat kumis
Halaman kesalahan untuk berbagai kode kesalahan HTTP (404, 500, 300)

Penyorotan sintaksis

Blok kode berpagar secara otomatis diproses oleh Prism.js. Bahasa yang didukung adalah bahasa default dalam paket Prism.js. Untuk penyorotan sintaksis, Anda harus menyertakan gaya Prism.js di index.html Anda.

 < link rel =" stylesheet " href =" https://cdn.jsdelivr.net/npm/prismjs@1/themes/prism.css " />

Menggunakan dengan Halaman GitHub

Anda dapat menggunakan Gumdrop dengan Halaman GitHub karena dapat berfungsi sebagai server file statis. Untuk mencegah Halaman GitHub mencoba mengubah situs Anda dengan Jekyll, tambahkan file .nojekyll kosong ke root situs Anda.