Repolode
Enviar
bwplotka

bwplotka/mdox

Uma CLI em Go para formatar Markdown no estilo GFM, gerar trechos de código a partir de comandos, verificar links e criar sites de documentação estáticos.

Ver no GitHub
Estrelas
84
Forks
12
Issues abertas
33
Último commit
há 4 dias

O que é?

mdox é uma ferramenta de linha de comando para manter a documentação de projetos correta e consistente. Ela formata arquivos Markdown diretamente, seguindo o GitHub Flavored Markdown, e valida links relativos e externos. Também permite ignorar URLs específicas ou verificar links de issues e pull requests do GitHub pela API do GitHub.

O recurso de geração de código reescreve blocos de código cercados marcados com a diretiva mdox-exec, executando um comando e inserindo a saída. Assim, textos de ajuda da CLI, arquivos de configuração de exemplo ou trechos de código-fonte ficam sincronizados com o código que descrevem. É possível declarar códigos de saída diferentes de zero para cada bloco.

Para sites, mdox pode reescrever links como caminhos relativos para sites com vários domínios ou versões e executar transformações que adicionam front matter e back matter, renomeiam ou movem arquivos e adaptam links para geradores de sites estáticos, como o Hugo. Também pode ser usado como biblioteca Go.

Recursos principais

  • 01Formata arquivos Markdown diretamente para manter um estilo GFM consistente.
  • 02Gera automaticamente o conteúdo de blocos de código executando comandos, como os que exibem a ajuda da CLI.
  • 03Verifica links relativos e externos, com regras configuráveis para ignorá-los e validação integrada ao GitHub.
  • 04Reescreve links como caminhos relativos para sites com vários domínios ou versões.
  • 05Transforma arquivos Markdown adicionando front matter e back matter e movendo arquivos para uso com geradores de sites estáticos.

Casos de uso

  • Manter atualizados, via CI, os textos de ajuda da CLI e os exemplos de configuração em um README do repositório.
  • Detectar links quebrados na documentação durante as verificações de pull requests.
  • Publicar a documentação versionada de um projeto em um site estático a partir de arquivos Markdown.

Início rápido

  1. 1

    Instale a CLI mdox com Go

  2. 2

    Formate arquivos Markdown com mdox fmt

    mdox fmt *.md

Antes de usar

  • O README não apresenta um comando go install explícito, então a etapa de instalação não é exibida como um comando.
  • O projeto é pequeno, com 80 estrelas, por isso o suporte da comunidade pode ser limitado.

Em coleções

Ferramentas de CLI e terminalGeradores de sites estáticos e ferramentas de documentação

Tópicos

#markdown#documentation#cli#link-checker#static-site#golang#code-generation

Perguntas frequentes

O que é mdox?
Uma CLI em Go para formatar Markdown no estilo GFM, gerar trechos de código a partir de comandos, verificar links e criar sites de documentação estáticos. mdox é uma ferramenta de linha de comando para manter a documentação de projetos correta e consistente. Ela formata arquivos Markdown diretamente, seguindo o GitHub Flavored Markdown, e valida links relativos e externos. Também permite ignorar URLs específicas ou verificar links de issues e pull requests do GitHub pela API do GitHub.
mdox é gratuito? Qual é a licença?
mdox é open source sob a licença Apache-2.0. Confira os termos da licença antes de usá-lo em produtos comerciais.
mdox ainda é mantido?
Manutenção ativa. O último commit de mdox foi em 3 de nov. de 2026.
Para que posso usar mdox?
Manter atualizados, via CI, os textos de ajuda da CLI e os exemplos de configuração em um README do repositório. Detectar links quebrados na documentação durante as verificações de pull requests. Publicar a documentação versionada de um projeto em um site estático a partir de arquivos Markdown.
Como instalar mdox?
Instale a CLI mdox com Go Formate arquivos Markdown com mdox fmt: mdox fmt *.md
Onde consigo mdox?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/bwplotka/mdox

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados