Linter Markdown

Verifica o Markdown por problemas de estilo: níveis de cabeçalho, cercas de código, consistência de listas e mais (motor de regras sem dependências)

Fatos principais

Categoria
Desenvolvimento e Web
Tipos de entrada
textarea, select
Tipo de saída
text
Cobertura de amostras
4
API disponível
Yes

Visão geral

O Linter Markdown é uma ferramenta prática que analisa seus arquivos Markdown para identificar problemas de formatação e estilo, como inconsistências em níveis de cabeçalho, cercas de código mal formatadas e listas desordenadas, garantindo documentos limpos e padronizados.

Quando usar

  • Antes de publicar artigos ou documentações técnicas em repositórios Git para garantir a consistência visual.
  • Ao revisar arquivos Markdown gerados automaticamente por scripts ou exportados de outras ferramentas.
  • Para validar a estrutura de cabeçalhos e blocos de código em arquivos README antes de commits.

Como funciona

  • Insira o texto Markdown que você deseja analisar no campo de entrada principal.
  • Selecione o conjunto de regras desejado (Padrão, Relaxado ou Estrito) e o formato do relatório (Texto ou JSON).
  • Visualize instantaneamente a lista de avisos ou erros de estilo encontrados no documento analisado.

Casos de uso

Padronização de arquivos README.md em projetos de código aberto.
Validação de posts de blog escritos em Markdown antes da publicação em geradores de sites estáticos.
Auditoria de documentação técnica para evitar quebras de layout em renderizadores de Markdown.

Exemplos

1. Validação de Documentação Técnica

Redator Técnico
Contexto
Um redator técnico precisa publicar um guia de API em Markdown, mas quer garantir que a hierarquia dos títulos esteja correta.
Problema
Evitar saltos incorretos de cabeçalhos e garantir que as cercas de código tenham a linguagem especificada.
Como usar
Cole o conteúdo do guia no campo de entrada, selecione o conjunto de regras 'Estrito' e escolha o formato de relatório 'Texto'.
Configuração de exemplo
ruleSet: strict, reportFormat: text
Resultado
O linter aponta que um cabeçalho H3 foi usado sem um H2 correspondente e que uma cerca de código está sem tag de linguagem.

2. Integração de Relatório de Lint em Pipeline

Desenvolvedor de Software
Contexto
Um desenvolvedor quer verificar a formatação de vários arquivos Markdown do projeto e processar os erros programaticamente.
Problema
Identificar erros de estilo em lote e obter os resultados em um formato estruturado para análise automatizada.
Como usar
Insira o conteúdo do Markdown, configure o conjunto de regras como 'Padrão' e defina o formato do relatório como 'JSON'.
Configuração de exemplo
ruleSet: standard, reportFormat: json
Resultado
A ferramenta gera um objeto JSON detalhando a linha, a coluna e a regra violada para cada inconsistência encontrada.

Testar com amostras

markdown

Hubs relacionados

FAQ

O que o Linter Markdown verifica?

Ele analisa a estrutura do documento, incluindo níveis de cabeçalho, cercas de código, consistência de listas e espaçamentos.

Quais são os conjuntos de regras disponíveis?

Você pode escolher entre os modos Padrão (standard), Relaxado (relaxed) e Estrito (strict).

Posso exportar o relatório em formato de dados?

Sim, você pode gerar o relatório de erros tanto em formato de texto simples quanto em JSON.

A ferramenta altera o meu arquivo original?

Não, ela apenas analisa o texto inserido e aponta os problemas de estilo sem modificar o conteúdo.

Preciso instalar alguma dependência para usar o linter?

Não, o motor de regras funciona diretamente no navegador sem dependências externas.

Documentação da API

Ponto final da solicitação

POST /pt/api/tools/markdown-linter

Parâmetros da solicitação

Nome do parâmetro Tipo Requerido Descrição
markdownInput textarea Sim -
ruleSet select Não -
reportFormat select Não -

Formato de resposta

{
  "result": "Processed text content",
  "error": "Error message (optional)",
  "message": "Notification message (optional)",
  "metadata": {
    "key": "value"
  }
}
Texto: Texto

Documentação de MCP

Adicione este ferramenta à sua configuração de servidor MCP:

{
  "mcpServers": {
    "elysiatools-markdown-linter": {
      "name": "markdown-linter",
      "description": "Verifica o Markdown por problemas de estilo: níveis de cabeçalho, cercas de código, consistência de listas e mais (motor de regras sem dependências)",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=markdown-linter",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

Você pode encadear várias ferramentas, ex: `https://elysiatools.com/mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp`, máx 20 ferramentas.

Se você encontrar algum problema, por favor, entre em contato conosco em [email protected]