md2html php

Site Markdown avec PHP

Ce projet est un site Web plat qui sert dynamiquement des fichiers de démarche à l'aide de PHP. Il existe de nombreuses options pour gérer le contenu du site Web, mais je préfère cette méthode pour mes sites Web personnels car:

• Aucune étape de construction: contrairement aux générateurs de sites statiques, le HTML est généré dynamiquement à partir des fichiers de marque lorsque des pages sont demandées, il n'y a donc pas besoin d'une étape de construction.
• Pas de base de données: il s'agit d'un site à fichiers plat, donc aucune base de données n'est requise pour stocker du contenu.
• Installation facile: utilisez GIT pour cloner ce repo
• Sauvegarde facile: il suffit de zipter le dossier Web
• Autorisation facile: créez simplement un dossier avec index.md
• URL propre: les URL de la page sont des chemins de dossier

Caractéristiques

• Liens d'ancrage automatique pour les titres
• Syntaxe mise en évidence dans les blocs de code
• Ajouter une table des matières en utilisant ![](TOC)
• Intégrer des vidéos YouTube en utilisant ![](YouTubeURL)
• Les fichiers de modèle sont HTML et faciles à personnaliser
• Les en-têtes et les tables de Markdown sont conçues pour ressembler à Github
• Génération dynamique de sitemap
• Génération dynamique de flux RSS
• Les fonctionnalités personnalisées sont faciles à ajouter

Exemples de sites Web

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

Notes du développeur

Installation

Étape 1: Utilisez git pour cloner ce dépôt en dehors de votre dossier Web. Je suggère /var/www/md2html

Étape 2: liez le dossier Ressources à une URL accessible au Web

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

Étape 3: Copiez le dossier de démonstration QuickStart dans votre dossier Web et votre site sera en direct!

Étape 4: Pour créer de nouvelles pages, créez des sous-reprendurs avec un index.md

Développer dans Docker

Ce référentiel dispose d'un site de démonstration prêt à l'emploi.

Exécutez docker-compose up -d et allez sur http: // localhost: 8081

En-tête de marque

Les fichiers de Markdown peuvent avoir un en-tête en option contenant la matière frontale pour personnaliser ce que le texte {{mustache}} est remplacé par dans le modèle. Les remplacements par défaut sont définis dans settings.php , et toutes les valeurs définies dans l'en-tête remplacent celles définies dans le fichier de paramètres.

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

Demandes de routage

Ce référentiel utilise .htaccess pour dire Apache (avec mod_rewrite) pour acheminer les demandes vers un dossier contenant un index.md vers un script PHP local pour les gérer. Si vous n'utilisez pas Apache ou Mod_Rewrite, utilisez le système que vous avez pour acheminer les demandes d'index de répertoire de manière similaire.

Déploiement continu avec actions github

Un site Web plat peut être cloné sur un serveur Web à l'aide de git , puis PHP peut exécuter git pull pour mettre à jour le contenu. En configurant les actions GitHub pour effectuer une demande HTTP qui exécute le script de mise à jour PHP chaque fois que de nouveaux engins sont poussés vers le référentiel, il est possible de garder un site Web en continu et automatiquement en synchronisation avec un référentiel GitHub.

• Clone ce repo dans un dossier à l'extérieur de la racine du web
• Lier symboliquement wwwroot à un chemin accessible au Web
• Créez une API_KEY secrète dans le projet GitHub
• Stockez la clé dans api.key dans le dossier racine (CHMOD 400 )
• Configurez les actions GitHub vers la demande http deploy.php lorsque de nouveaux engins sont poussés, en utilisant l' API_KEY comme jeton de porteur (voir Deploy.yml)

Générateur de sites statiques alternatifs pur-python

Après avoir utilisé ce système basé sur PHP pendant plusieurs mois, j'ai grandi pour en profiter pour de grands sites avec des centaines de pages, mais pour de très petits sites avec seulement quelques pages .

J'ai créé Palila pour répondre à ce besoin - un petit script python pour convertir index.md en index.html qui peut être exécuté localement (lors de l'édition) ou à distance (lors du déploiement).