md2html php

Sitio de Markdown con PHP

Este proyecto es un sitio web de archivo plano que sirve dinámicamente archivos de Markdown usando PHP. Hay muchas opciones para administrar el contenido del sitio web, pero prefiero este método para mis sitios web personales porque:

• Sin paso de compilación: a diferencia de los generadores de sitios estáticos, HTML se genera dinámicamente a partir de archivos Markdown cuando se solicitan páginas, por lo que no hay necesidad de un paso de compilación.
• No hay base de datos: este es un sitio de archivo plano, por lo que no se requiere una base de datos para almacenar contenido.
• Instalación fácil: use git para clonar este repositorio
• Copia de seguridad fácil: simplemente cierre la carpeta web
• Autorización fácil: solo cree una carpeta con index.md
• URL limpias: las URL de página son rutas de carpetas

Características

• Enlaces de anclaje automático para encabezados
• Destacación de sintaxis en bloques de código
• Agregue una tabla de contenido usando ![](TOC)
• Incrustación de videos de YouTube ![](YouTubeURL)
• Los archivos de plantilla son HTML y son fáciles de personalizar
• Los encabezados y las mesas de Markdown están diseñados para parecerse a GitHub
• Generación dinámica de mapa del sitio
• Generación dinámica de alimentación RSS
• La funcionalidad personalizada es fácil de agregar

Sitios web de ejemplo

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

Notas de desarrollador

Instalación

Paso 1: use git para clonar este repositorio fuera de su carpeta web. Sugiero /var/www/md2html

Paso 2: Enlace la carpeta de recursos a una URL de acceso web accesible

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

Paso 3: ¡Copie la carpeta de demostración QuickStart a su carpeta web y su sitio estará en vivo!

Paso 4: Para crear nuevas páginas, cree subcarpetas con un index.md

Desarrollar en Docker

Este repositorio tiene un sitio de demostración listo para ejecutar.

Ejecute docker-compose up -d y vaya a http: // localhost: 8081

Encabezado

Los archivos de Markdown pueden tener un encabezado opcional que contiene materia frontal para personalizar con qué se reemplaza el texto {{mustache}} en la plantilla. Los reemplazos predeterminados se definen en settings.php , y cualquier valor definido en el encabezado anule los definidos en el archivo de configuración.

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

Solicitudes de enrutamiento

Este repositorio usa .htaccess para decirle a Apache (con mod_rewrite) para que enrute las solicitudes a una carpeta que contiene un index.md a un script PHP local para manejarlas. Si no usa apache o mod_rewrite, use cualquier sistema que tenga para enrutar las solicitudes de índice de directorio de manera similar.

Despliegue continuo con acciones de Github

Un sitio web de archivo plano se puede clonar en un servidor web usando git , luego PHP puede ejecutar git pull para actualizar el contenido. Al configurar las acciones de GitHub para realizar una solicitud HTTP que ejecute el script de actualización de PHP cada vez que se empujan los nuevos compromisos al repositorio, es posible mantener un sitio web de forma continua y automática sincronizada con un repositorio de GitHub.

• Clonar este repositorio en una carpeta fuera de la raíz web
• Vincular simbólicamente wwwroot a una ruta web accesible
• Cree un API_KEY secreto en el proyecto GitHub
• Almacene la tecla en api.key en la carpeta Root (Chmod 400 )
• Configure las acciones de GitHub en HTTP Solicitud deploy.php Cuando se presionan los nuevos compromisos, utilizando el API_KEY como token de portador (ver implement.yml)

Alternativo Generador de sitios estáticos de Python Pure-Python

Después de usar este sistema basado en PHP durante varios meses, llegué a disfrutarlo en sitios grandes con 100 de páginas, pero para sitios muy pequeños con solo unas pocas páginas se sintió engorroso para activar una instancia de Docker solo para hacer una pequeña edición de la página .

Creé Palila para satisfacer esta necesidad: un pequeño script de Python para convertir index.md a index.html que se puede ejecutar localmente (al editar) o de forma remota (al implementar).