md2html php

Сайт разметки с PHP

Этот проект представляет собой плоский веб-сайт, который динамически обслуживает файлы разметки с использованием PHP. Есть много вариантов управления контентом веб -сайта, но я предпочитаю этот метод для моих личных веб -сайтов, потому что:

• Нет шага по сборке: в отличие от статических генераторов сайтов, HTML динамически генерируется из файлов разметки при запросе страниц, поэтому нет необходимости в шаге сборки.
• Без базы данных: это плоский сайт, поэтому для хранения контента не требуется база данных.
• Легкая установка: используйте git, чтобы клонировать это репо
• Легкая резервная копия: просто застегивайте папку веб -сайта
• Легко авторинг: просто создайте папку с index.md
• Чистые URL -адреса: URL -адреса страниц - это пути папок

Функции

• Автоматические якорные ссылки для заголовков
• Синтаксис выделения в кодовых блоках
• Добавьте содержимое содержимого с помощью ![](TOC)
• Встроенные видео на YouTube с использованием ![](YouTubeURL)
• Файлы шаблонов HTML и просты в настройке
• Заголовки и таблицы отмечены, чтобы напоминать GitHub
• Динамичная генерация карты сайта
• Динамическая генерация RSS -корма
• Пользовательские функции легко добавить

Пример веб -сайтов

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

Разработчик примечания

Установка

Шаг 1: Используйте git , чтобы клонировать это репо вне вашей веб -папки. Я предлагаю /var/www/md2html

Шаг 2: Свяжите папку ресурсов с доступным Web URL

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

Шаг 3: Скопируйте демонстрационную папку QuickStart в вашу веб -папку, и ваш сайт будет вживую!

Шаг 4: Чтобы создать новые страницы, создайте подразделения с помощью index.md

Развиваться в Docker

Этот репозиторий имеет готовый к демо-сайту.

Запустите docker-compose up -d и перейдите по адресу http: // localhost: 8081

Заголовок разметки

Файлы разметки могут иметь дополнительный заголовок, содержащий передний вопрос , чтобы настроить то, что {{mustache}} текст заменяется в шаблоне. Замена по умолчанию определена в settings.php , и любые значения, определенные в заголовке, переопределяют те, которые определены в файле «Настройки».

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

Запросы на маршрутизацию

Этот репозиторий использует .htaccess , чтобы сообщить Apache (с MOD_REWRITE) для маршрутизации запросов в папку, содержащую index.md в локальный сценарий PHP для их обработки. Если вы не используете Apache или Mod_rewrite, используйте любую систему, которую вы делаете для маршрутизации запросов индекса каталогов аналогично.

Непрерывное развертывание с действиями GitHub

Веб-сайт с плоским файлом может быть клонирован на веб-сервер, используя git , затем PHP может выполнить git pull чтобы обновить контент. Настройка действий GitHub для выполнения HTTP -запроса, который выполняет сценарий PHP Update каждый раз, когда новые коммиты выдвигаются в репозиторий, можно непрерывно и автоматически держать веб -сайт в репозитории GitHub.

• Клонировать это репо в папке за пределами веб -корня
• Символически связывать wwwroot с доступным веб-пути
• Создайте секретный API_KEY в проекте GitHub
• Храните ключ в api.key в корневой папке (CHMOD 400 )
• Настройте действия GitHub на HTTP -запрос deploy.php когда нажимают новые коммиты, используя API_KEY в качестве токена носителя (см. Deploy.yml)

Альтернативный генератор статического сайта Pure Python

После использования этой системы на основе PHP в течение нескольких месяцев я вырос, чтобы насладиться ею для больших участков со сотнями страниц, но для очень маленьких сайтов с несколькими страницами это было удобно, чтобы запустить экземпляр Docker, просто для того, чтобы сделать небольшое редактирование страницы Полем

Я создал Palila для удовлетворения этой потребности - небольшой скрипт Python для преобразования index.md в index.html, который можно запускать локально (при редактировании) или удаленно (при развертывании).