Como compilar markdown usando PHP » Computer Science Master
Nesse post vamos explicar como utilizar o PHP para compilar e mostrar texto escrito na linguagem markdown. Você já deve ter usado essa linguagem escrevendo os "readme.md" do github e podemos dizer que essa linguagem ganhou muito destaque e é bastante utilizada para vários propósitos atualmente.
Gosta de exemplos práticos como esse? temos outros exemplos documentados em nosso website 🙂 clique para acessar.
Para começar usar o markdown você precisa apenas de um editor de texto que compreenda essa linguagem (por exemplo, o sublime text) e salvar um arquivo com a extensão ".md" e pronto você estará apto a escrever suas primeiras linhas de código.
O texto escrito em markdown será compilado para HTML posteriormente para ser mostrado pelos navegadores, para isso você precisará seguir alguns padrões. Por exemplo:
Para escrever títulos:
H1 → # primeiro título
H2 → ## segundo título
Escreva usando bullets:
- primeiro bullet
- segundo bullet
- terceiro bullet
Use numeração:
1. Primeiro tópico
2. Segundo tópico
3. Terceiro tópico
Além disso, existem formas de inserir formatações básicas como um negrito ou itálico:
**Esse texto está em negrito**
Esse não é um tutorial que para explicar em detalhes a sintaxe do markdown, mas não deixe de visitar tutoriais na internet (como esse) para entender melhor como essa linguagem funciona e disponibiliza sua formatação.
Como interpretar markdown usando PHP
Para fazer o "parse" de texto escrito em markdown para PHP você irá precisar de um parser específico para isso. Para nossa sorte a comunidade já disponibilizou essa ferramenta gratuitamente para todos e você pode fazer download e usar em seus projetos gratuitamente. Para esse exemplo eu testei 3 ferramentas diferentes disponíveis no github e também disponibilizadas no composer, são elas:
Parsedown – uma biblioteca disponibilizada no github por Emanuil Erusev.
CommonMarker – biblioteca disponibilizada no github por Garen Torikian.
PHPmarkdown – biblioteca disponibilizada no github por Michel Fortin.
Para todos os parsers que testamos será necessário realizar o mesmo procedimento de configuração do ambiente, para isso será necessário que você tenha instalado o composer em sua máquina (veja aqui um breve tutorial). Além disso, você também precisa instalar e configurar o seu ambiente PHP (servidor apache).
Se você quer ver nosso exemplo funcionando, primeiramente acesse nosso github e siga os seguintes passos:
Faça um clone do nosso projeto no seu computador e abra seu terminal nas pastas de cada ferramenta:
2. Agora você poderá executar o comando para instalar as dependências:
Agora você possui a pasta "vendor" e todos os códigos necessários para fazer o parse do markdown, mas lembre-se você precisará fazer isso para todas as pastas.
Agora você poderá rodar seu servidor apache para ver o projeto ao vivo. Você verá essa página web:
Realizando a leitura de arquivos markdown
Para realizar a leitura de arquivos, podemos usar a função "built-in" do PHP "file_get_contents" e posteriormente usar o parser para traduzir esse texto em markdown.
$exs = array();
for ($i = 1 ; $i <= 3; $i++){
array_push($exs,file_get_contents("../markdownFiles/exercise0$i.md"));
Instanciando o parser
Sintaxe do parsedown:
Sintaxe do CommonMarker:
Sintaxe do PHP markdown:
Mostrando o resultado na tela
// $exs é um vetor que contém strings de texto escrito em markdown
echo $Parsedown->text($exs[$i]);
echo $converter->convertToHtml($exs[$i]);
// $exs é um vetor que contém strings de texto escrito em markdownecho Markdown::defaultTransform($exs[$i]);
Usar o markdown pode ser uma importante feature para seu projeto quando você não quer que os usuários escrevam código diretamente em HTML. O markdown permite uma formatação bastante rica e bem fácil de escrever, além disso, você salva esses arquivos e pode fazer o versionamento dos mesmos rastreando as modificações.