md2html php

Site de marcação com PHP

Este projeto é um site de arquivo plano que serve dinamicamente os arquivos de marcação usando o PHP. Existem muitas opções para gerenciar o conteúdo do site, mas eu prefiro esse método para meus sites pessoais porque:

• Sem etapa de construção: Ao contrário dos geradores de sites estáticos, o HTML é gerado dinamicamente a partir de arquivos de marcação quando as páginas são solicitadas, portanto não há necessidade de uma etapa de construção.
• Sem banco de dados: este é um site de arquivo plano, portanto, nenhum banco de dados é necessário para armazenar conteúdo.
• Instalação fácil: use Git para clonar este repo
• Backup fácil: basta fechar a pasta da web
• Fácil autoria: basta criar uma pasta com index.md
• URLs limpos: URLs de página são caminhos de pasta

Características

• Links de âncora automáticos para títulos
• Sintaxe destacando em blocos de código
• Adicione um índice usando ![](TOC)
• Incorporar vídeos do YouTube usando ![](YouTubeURL)
• Os arquivos de modelo são HTML e fáceis de personalizar
• Os títulos e mesas de marcação são estilizados para se parecer com o github
• Geração dinâmica de mapa do site
• Geração dinâmica de feed RSS
• A funcionalidade personalizada é fácil de adicionar

Exemplo de sites

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

Notas do desenvolvedor

Instalação

Etapa 1: use git para clonar este repositório fora da pasta da web. Eu sugiro /var/www/md2html

Etapa 2: vincule a pasta de recursos a um URL acessível pela Web

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

Etapa 3: copie a pasta de demonstração do QuickStart para sua pasta da web e seu site estará ao vivo!

Etapa 4: para criar novas páginas, crie sub-osdores com um index.md

Desenvolver em Docker

Este repositório possui um site de demonstração pronto para executar.

Execute docker-compose up -d e vá para http: // localhost: 8081

Cabeçalho de Marydown

Os arquivos de marcação podem ter um cabeçalho opcional contendo matéria frontal para personalizar o texto {{mustache}} é substituído no modelo. As substituições padrão são definidas no settings.php e quaisquer valores definidos no cabeçalho substituem os definidos no arquivo de configurações.

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

Solicitações de roteamento

Este repositório usa .htaccess para informar o Apache (com mod_rewrite) para rotear solicitações para uma pasta contendo um index.md para um script PHP local para lidar com eles. Se você não usar o Apache ou Mod_rewrite, use qualquer sistema que você tenha para rotear solicitações de índice de diretório da mesma forma.

Implantação contínua com ações do GitHub

Um site de arquivo plano pode ser clonado em um servidor da web usando git , então o PHP pode executar git pull para atualizar o conteúdo. Ao configurar as ações do GitHub para fazer uma solicitação HTTP que execute o script de atualização do PHP toda vez que novos compromissos forem empurrados para o repositório, é possível manter um site de maneira contínua e automática em sincronia com um repositório do GitHub.

• Clone este repositório em uma pasta fora da raiz da web
• Link simbolicamente wwwroot a um caminho acessível na Web
• Crie uma API_KEY secreta no projeto GitHub
• Armazene a chave na api.key na pasta raiz (CHMOD 400 )
• Configure as ações do GitHub para o HTTP Request deploy.php quando novos commits forem empurrados, usando o API_KEY como um token portador (consulte o Implement.yml)

Gerador de site estático pico alternativo

Depois de usar esse sistema baseado em PHP por vários meses, eu cresci para apreciá-lo em grandes locais com 100s de páginas, mas para locais muito pequenos com apenas algumas páginas, parecia pesado de iniciar uma instância do Docker apenas para fazer uma pequena página de edição de página .

Criei Palila para atender a essa necessidade - um pequeno script python para converter index.md em index.html que pode ser executado localmente (ao editar) ou remotamente (ao implantar).