Handmade Blog adalah penjana blog statik ringan untuk orang yang ingin memulakan blog dengan cepat. Ia menyokong dokumen jenis artikel untuk catatan blog, dokumen jenis kerja untuk portfolio, sorotan kod, sintaks KaTeX, nota kaki, dan banyak lagi.
Demo: Di sini
-
Klik butang 'Use this template' di atas senarai fail untuk membuat repositori baru. Sekiranya anda ingin menggunakan domain github.io, anda mesti memberi nama repositori
{ID_ANDA}.github.io
. (e.g.,betty-grof.github.io
) Jangan lupa untuk mengaktifkan pilihan 'Include all branches'. -
Klik tab 'Settings' di repositori anda, dan tetapkan cabang sumber untuk GitHub Pages ke cabang
gh-pages
. GitHub Pages akan menghoskan laman web anda berdasarkan cabanggh-pages
. Anda akan dapat mengakses laman web melaluihttps://{ID_ANDA}.github.io/
dalam beberapa minit. -
Klon repositori, dan pasang pakej node.
$ git clone https://github.com/{ID_ANDA}/{NAMA_REPOSITORI}.git # git clone https://github.com/betty-grof/betty-grof.github.io.git $ cd {NAMA_REPOSITORI} # cd betty-grof.github.io $ npm install
-
Ubah fail
config.json
di direktoriservices
untuk menetapkan tajuk dan sari kata blog anda.{ "blogTitle": "Betty Grof", "blogSubtitle": "Oh My Glob", "article": { "tableOfContents": true } }
-
Mulakan pelayan tempatan di
http://localhost:1234/
. Skripnpm start
akan membuka pelayan tempatan berdasarkan direktoriserver
.$ npm start
-
Komit dan hantar perubahan dalam direktori kerja anda ke repositori terpencil.
$ git add ./services/config.json $ git commit -m "Set the blog title and subtitle" $ git push origin master
-
Jalankan skrip
deploy
jika anda sudah bersedia untuk menghoskan laman web. Skrip ini membina fail tempatan ke direktoridist
dan menolak ke cabanggh-pages
yang hanya berisi fail di direktoridist
. GitHub Pages akan menghoskan laman web anda dihttps://{ID_ANDA}.github.io/
berdasarkan cabanggh-pages
secara automatik.$ npm run deploy
-
Tulis dokumen di direktori
_articles
atau_works
. -
Jalankan skrip
npm run publish article
ataunpm run publish work
untuk menukar dokumen markdown ke HTML. -
Pratonton dokumen yang ditukar pada pelayan tempatan menggunakan skrip
npm start
. -
Komit dan tekan perubahan ke repositori, dan jalankan
npm run deploy
untuk menyebarkan.
Ubah suai templat ejs untuk mengubah kandungan halaman yang ada. Contohnya, jika anda ingin meletakkan gambar ke halaman arahan, buka fail app/templates/index.ejs
, dan tambahkan tag img
ke elemen main-container
.
<main id="main-container">
<img src="../assets/profile.jpg" alt="My profile picture" />
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>
</main>
Kemudian, jalankan skrip npm run publish page
untuk menerbitkan halaman yang diubah dan pratonton perubahan pada pelayan tempatan menggunakan skrip npm start
.
$ npm run publish page
$ npm start
Sekiranya anda bersedia untuk menyebarkan, jalankan skrip npm run deploy
. Anda tidak hanya boleh menukar halaman utama tetapi halaman seperti ini. (Anda mungkin perlu memahami struktur projek.)
_articles
- Fail markdown untuk catatan blog._works
- Fail markdown untuk portfolio.app
assets
- Sebarang fail yang akan diimport oleh fail HTML seperti gambar, fon, dll.public
- Fail HTML dihasilkan oleh skrippublish
. Direktoriserver
dandist
adalah berdasarkan direktori ini. Jangan ubah fail di bawah direktori ini secara langsung.article
- Fail HTML ditukar dari direktori_articles
.work
- Fail HTML ditukar dari direktori_works
.
src
- Kod sumber yang akan diimport oleh fail HTML.css
- Fail CSS dihasilkan oleh skripbuild
.scss
ts
static
- Sebarang fail statik yang tidak dikompilasi oleh skripbuild
sepertirobots.txt
,sitemap.xml
, atau SEO files. Skripbuild
menyalinkan semua fail di bawah direktori ini ke direktoridist
.templates
- Fail templat EJS. Skrippublish
menukar templat di bawah direktori ini ke fail HTML.
dist
- Fail dikompilasi oleh skripbuild
. Skripdeploy
menyebarkan laman web ke GitHub Pages berdasarkan direktori ini. Jangan ubah fail di bawah direktori ini secara langsung.server
- Fail dikompilasi oleh skripbuild
. Skripstart
membuka pelayan tempatan berdasarkan direktori ini. Jangan ubah fail di bawah direktori ini secara langsung.services
- Kod sumber yang melaksanakan skrippublish
.classes
models
tools
- Kod sumber yang melaksanakan pelbagai skrip npm.
- parksb.github.io: https://github.com/parksb/parksb.github.io
- betty-grof.github.io: https://github.com/betty-grof/betty-grof.github.io
Memulakan pelayan pembangunan tempatan di http://localhost:1234/.
Menukar templat ke fail HTML.
$ npm run publish article
Menukar semua artikel.
$ npm run publish works
Menukar semua karya.
$ npm run publish article 5
Menukar artikel yang id adalah 5.
$ npm run publish work 3
Menukar karya yang id adalah 3.
$ npm run publish page
Menukar semua halaman.
Membangun semula fail templat dalam direktori templates
dan fail markdown dalam direktori _articles
secara automatik setiap kali fail diubah.
Membina fail dengan parcel bundler.
Membina dan menyebarkan fail.
Projek ini dilesenkan di bawah Lesen MIT - lihat fail LESEN untuk maklumat lanjut..