md2html php

Markdown -Site mit PHP

Dieses Projekt ist eine Flat-File-Website, die Markdown-Dateien mit PHP dynamisch bedient. Es gibt viele Optionen für die Verwaltung von Website -Inhalten, aber ich bevorzuge diese Methode für meine persönlichen Websites, da:

• Kein Build -Schritt: Im Gegensatz zu statischen Site -Generatoren wird HTML dynamisch aus Markdown -Dateien generiert, wenn Seiten angefordert werden, sodass kein Erstellungschritt erforderlich ist.
• Keine Datenbank: Dies ist eine Website für flache Datei, daher ist keine Datenbank erforderlich, um Inhalte zu speichern.
• Einfache Installation: Verwenden Sie Git, um dieses Repo zu klonen
• Einfache Backup: einfach den Webordner reiße
• Einfache Authoring: Erstellen Sie einfach einen Ordner mit index.md
• Saubere URLs: Seiten -URLs sind Ordnerpfade

Merkmale

• Automatische Ankerlinks für Überschriften
• Syntax -Hervorhebung in Codeblöcken
• Fügen Sie ein Inhaltsverzeichnis mit ![](TOC) hinzu
• Einbetten Sie YouTube -Videos mit ![](YouTubeURL) ein
• Vorlagendateien sind HTML und einfach anpassen
• Markdown -Überschriften und -Tische sind so gestaltet, dass sie Github ähneln
• Dynamische Erzeugung von Sitemap
• Dynamische Erzeugung von RSS -Feed
• Benutzerdefinierte Funktionen sind einfach hinzuzufügen

Beispiel Websites

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

Entwicklernotizen

Installation

Schritt 1: Klonen Sie mit git dieses Repo außerhalb Ihres Webordners. Ich schlage /var/www/md2html vor

Schritt 2: Verknüpfen Sie den Ressourcenordner mit einer Web-zugänglichen URL

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

Schritt 3: Kopieren Sie den QuickStart -Demo -Ordner in Ihren Webordner und Ihre Website wird live sein!

Schritt 4: Um neue Seiten zu erstellen, erstellen Sie Unterordner mit einem index.md

Sich in Docker entwickeln

Dieses Repository verfügt über eine vorbereitende Demo-Site.

Führen Sie docker-compose up -d und gehen Sie zu http: // localhost: 8081

Markdown -Header

Markdown -Dateien können einen optionalen Header haben, der vordere Materie enthält, um anzupassen, was {{mustache}} Text in der Vorlage ersetzt wird. Standard -Ersatze sind in settings.php definiert, und alle, die in der Header definiert sind, überschreiben die in der Einstellungsdatei definierten Werte.

 ---
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...

Routing -Anfragen

Dieses Repository verwendet .htaccess , um Apache (mit mod_rewrite) zu sagen, Anforderungen an einen Ordner mit einem index.md an ein lokales PHP -Skript zu leiten, um sie zu verarbeiten. Wenn Sie Apache oder mod_rewrite nicht verwenden, verwenden Sie das System, das Sie für die Verzeichnis -Indexanforderungen in ähnlicher Weise zur Verfügung stellen müssen.

Kontinuierliche Bereitstellung mit GitHub -Aktionen

Eine flache Website kann mit git auf einen Webserver kloniert werden. Anschließend kann PHP git pull ausführen, um den Inhalt zu aktualisieren. Durch die Konfiguration von GitHub -Aktionen, um eine HTTP -Anforderung zu erstellen, die das PHP -Update -Skript jedes Mal ausführt, wenn neue Commits in das Repository weitergegeben werden, ist es möglich, eine Website kontinuierlich und automatisch mit einem GitHub -Repository zu synchronisieren.

• Klonen Sie dieses Repo in einem Ordner außerhalb des Webrouchs
• Verknüpfen Sie symbolisch wwwroot mit einem web zugänglichen Pfad
• Erstellen Sie im GitHub -Projekt einen geheimen API_KEY
• Speichern Sie den Schlüssel in api.key im Root -Ordner (CHMOD 400 )
• Konfigurieren Sie GitHub -Aktionen in HTTP Request deploy.php , wenn neue Commits mit dem API_KEY als Trägertoken gedrückt werden (siehe deploy.yml).

Alternative Pure-Python Static Site Generator

Nachdem ich dieses PHP-basierte System mehrere Monate lang verwendet hatte, genoss ich es für große Websites mit 100 Seiten, aber für sehr kleine Websites mit nur wenigen Seiten fühlte es sich umständlich an, eine Docker-Instanz aufzubauen, nur um eine kleine Seitenbearbeitung durchzuführen .

Ich habe Palila erstellt, um diesen Bedarf zu erfüllen - ein kleines Python -Skript zum Konvertieren von Index.md in index.html, das lokal (beim Bearbeiten) oder aus der Bereitstellung ausgeführt werden kann.