hugo book

Tema Buku Hugo - Garpu PANAS

Tema dokumentasi Hugo sesederhana buku biasa

Fitur

• Desain sederhana yang bersih

• Ramah seluler

• Dapat disesuaikan

• Dirancang agar tidak mengganggu tata letak lainnya

• Konfigurasi awal nol

Persyaratan

• Hugo 0,43 atau lebih tinggi

• Versi diperpanjang Hugo, baca lebih lanjut di sini

Instalasi

Arahkan ke root situs web Hugo Anda dan jalankan:

git submodule add https://github.com/alex-shpak/hugo-book themes/book

Kemudian jalankan hugo (atau setel theme: book di file konfigurasi)

hugo server --theme book

Menu

Menu pohon file (default)

Secara default, tema akan merender halaman dari bagian content/docs sebagai menu dalam struktur pohon.
Anda dapat mengatur title dan weight di halaman depan untuk menyesuaikan urutan dan judul dalam menu.

Menu bundel daun

Anda juga dapat menggunakan bundel daun dan konten index.md -nya sebagai menu.

Mengingat Anda memiliki struktur file ini

├── content
│   ├── docs
│   │   ├── page-one.md
│   │   └── page-two.md
│   └── posts
│       ├── post-one.md
│       └── post-two.md

Buat file content/docs/menu/index.md dengan konten

 ---headless: true---- [Contoh Buku](/docs/)
  - [Halaman Pertama](/docs/halaman-satu)
  - [Halaman Kedua](/docs/halaman-dua)- [Blog](/posts)

Dan Aktifkan dengan pengaturan BookMenuBundle: /docs/menu dalam konfigurasi Situs

• Contoh menunya

• Contoh file konfigurasi

• Bundel daun

blog

Blog sederhana didukung untuk posts bagian

Konfigurasi

Konfigurasi Situs

Ada beberapa opsi konfigurasi yang dapat Anda tambahkan ke file config.yml|json|toml Anda

 # (Opsional) Setel ini ke true jika Anda menggunakan huruf kapital dalam nama filedisablePathToLower: true# (Opsional) Setel ini ke true untuk mengaktifkan tanggal 'Terakhir Dimodifikasi berdasarkan' dan informasi git author# pada halaman ketik 'doc'.enableGitInfo: true# (Peringatan) Tema dimaksudkan untuk penggunaan dokumentasi, sehingga tidak menampilkan taksonomi.# Anda dapat menyembunyikan peringatan terkait dengan konfigurasi di bawahdisableKinds: ["taxonomy", "taxonomyTerm"]params: # (Opsional, default true) Menampilkan atau menyembunyikan daftar isi secara global
  # Anda juga dapat menentukan parameter ini per halaman di bagian depan
  BookShowToC: benar

  # (Opsional, tidak ada default) Atur bundel daun untuk dirender sebagai menu samping
  # Bila struktur dan bobot file tidak ditentukan akan digunakan
  Paket Menu Buku: /menu

  # (Opsional, dokumen default) Tentukan bagian konten yang akan dirender sebagai menu
  # Anda juga dapat menetapkan nilai ke "*" untuk merender semua bagian ke menu
  Bagian Buku: dokumen

  # Nilai ini merupakan duplikat dari $link-color untuk membuat sorotan tautan aktif dalam mode bundel menu
  # BukuMenuBundleActiveLinkColor: #004ed0

  # Sertakan skrip JS di halaman. Dinonaktifkan secara default.
  # - Pertahankan menu samping pada posisi gulir yang sama selama navigasi
  BookEnableJS: benar

  # Tetapkan lokasi repositori sumber.
  # Digunakan untuk tautan 'Terakhir Dimodifikasi' dan 'Edit halaman ini'.
  Repo Buku: https://github.com/alex-shpak/hugo-book

  # Aktifkan link "Edit halaman ini" untuk jenis halaman 'doc'.
  # Dinonaktifkan secara default. Batalkan komentar untuk mengaktifkan. Memerlukan parameter 'BookRepo'.
  # Jalur harus mengarah ke direktori 'konten' repo.
  BookEditPath: edit/master/exampleSite/content

Konfigurasi Halaman

Anda dapat menentukan parameter tambahan per halaman di materi depan

 ---# Setel tipe ke 'docs' jika Anda ingin merender halaman di luar bagian yang dikonfigurasi atau jika Anda merender bagian selain 'docs'type: docs# Setel bobot halaman untuk mengatur ulang item di menu pohon file (jika BookMenuBundle tidak disetel)berat: 10# (Opsional) Atur untuk menandai halaman sebagai bagian datar di menu pohon file (jika BookMenuBundle tidak disetel)bookFlatSection: true# (Opsional) Atur untuk menyembunyikan daftar isi, menimpa valuebookShowToC global: false---

Sebagian

Ada beberapa bagian kosong yang dapat Anda timpa di layouts/partials/

Sebagian	Penempatan
layouts/partials/docs/inject/head.html	Sebelum menutup tag <head>
layouts/partials/docs/inject/body.html	Sebelum menutup tag <body>
layouts/partials/docs/inject/menu-before.html	Di awal blok menu <nav>
layouts/partials/docs/inject/menu-after.html	Di akhir blok menu <nav>

Berkontribusi

Kontribusi dipersilahkan dan saya akan meninjau dan mempertimbangkan permintaan penarikan.
Tujuan utamanya adalah:

• Tetap sederhana

• Pertahankan konfigurasi default minimal (atau nol).

• Hindari gangguan pada tata letak yang ditentukan pengguna

Jangan ragu untuk membuka masalah jika Anda kehilangan beberapa konfigurasi atau opsi penyesuaian.

Lisensi

MIT