md2html php

Situs Markdown dengan PHP

Proyek ini adalah situs web file datar yang secara dinamis menyajikan file penurunan harga menggunakan PHP. Ada banyak opsi untuk mengelola konten situs web, tetapi saya lebih suka metode ini untuk situs web pribadi saya karena:

• No Build Step: Tidak seperti generator situs statis, HTML dihasilkan secara dinamis dari file markdown ketika halaman diminta, jadi tidak perlu untuk langkah build.
• No Database: Ini adalah situs file flat, jadi tidak ada database yang diperlukan untuk menyimpan konten.
• Instalasi Mudah: Gunakan git untuk mengkloning repo ini
• Cadangan Mudah: Cukup ritsleting folder web
• Penulisan Mudah: Cukup buat folder dengan index.md
• URL bersih: URL halaman adalah jalur folder

Fitur

• Tautan jangkar otomatis untuk judul
• Sorot Sintaks di Blok Kode
• Tambahkan Daftar Isi Menggunakan ![](TOC)
• Embed Video YouTube Menggunakan ![](YouTubeURL)
• File template html dan mudah disesuaikan
• Judul dan meja penurunan harga ditata menyerupai gitub
• Generasi Dinamis Sitemap
• Generasi Dinamis RSS Feed
• Fungsionalitas khusus mudah ditambahkan

Contoh situs web

• https://swharden.com
• https://swharden.com/Pyabf
• https://swharden.com/csharpdatavis
• https://swharden.com/software/ljpcalc

Catatan Pengembang

Instalasi

Langkah 1: Gunakan git untuk mengkloning repo ini di luar folder web Anda. Saya sarankan /var/www/md2html

Langkah 2: Tautkan folder sumber daya ke URL yang dapat diakses web

 ln -ls /var/www/md2html/resources /var/www/html/md2html-resources

Langkah 3: Salin folder demo QuickStart ke folder web Anda dan situs Anda akan langsung!

Langkah 4: Untuk membuat halaman baru, membuat sub-folder dengan index.md

Berkembang di Docker

Repositori ini memiliki situs demo yang siap dijalankan.

Jalankan docker-compose up -d dan Pergi ke http: // localhost: 8081

Header markdown

File Markdown dapat memiliki header opsional yang berisi materi depan untuk menyesuaikan apa yang {{mustache}} teks diganti dengan template. Penggantian default didefinisikan dalam settings.php , dan nilai apa pun yang ditentukan dalam header menimpa yang ditentukan dalam file Pengaturan.

 ---
title: this text becomes the title element in the header
description: this text becomes header metadata for search engines to display
---

# My Markdown Article

The rest of the ***Markdown*** text goes here...

Permintaan perutean

Repositori ini menggunakan .htaccess untuk memberi tahu Apache (dengan mod_rewrite) untuk merutekan permintaan ke folder yang berisi index.md ke skrip PHP lokal untuk menanganinya. Jika Anda tidak menggunakan Apache atau MOD_REWRITE, gunakan sistem apa pun yang Anda miliki untuk merutekan permintaan indeks direktori dengan cara yang sama.

Penempatan terus menerus dengan tindakan gitub

Situs web Flat-File dapat dikloning ke server web menggunakan git , maka PHP dapat menjalankan git pull untuk memperbarui konten. Dengan mengonfigurasi tindakan github untuk membuat permintaan HTTP yang mengeksekusi skrip pembaruan PHP setiap kali komit baru didorong ke repositori, dimungkinkan untuk menjaga situs web terus menerus dan secara otomatis sinkronisasi dengan repositori github.

• Klon repo ini di folder di luar root web
• Secara simbolis tautkan wwwroot ke jalur yang dapat diakses web
• Buat API_KEY rahasia di proyek GitHub
• Simpan kunci di api.key di folder root (Chmod 400 )
• Konfigurasikan Tindakan GitHub ke permintaan http deploy.php Saat komit baru didorong, menggunakan API_KEY sebagai token pembawa (lihat Deploy.yml)

Alternatif generator situs statis murni-python

Setelah menggunakan sistem berbasis PHP ini selama beberapa bulan saya tumbuh untuk menikmatinya untuk situs besar dengan 100-an halaman, tetapi untuk situs yang sangat kecil dengan hanya beberapa halaman, rasanya rumit untuk memulai instance Docker hanya untuk melakukan pengeditan halaman kecil kecil .

Saya membuat Palila untuk memenuhi kebutuhan ini - skrip Python kecil untuk mengonversi index.md ke index.html yang dapat dijalankan secara lokal (saat mengedit) atau dari jarak jauh (saat menggunakan).