Fatos principais
- Categoria
- Texto e escrita
- Tipos de entrada
- textarea, select, checkbox
- Tipo de saída
- html
- Cobertura de amostras
- 4
- API disponível
- Yes
Visão geral
O Verificador de Estilo e Lint de Markdown analisa seus documentos para identificar desvios de formatação, inconsistências de estilo e problemas de tipografia. Ele valida o texto com base em cerca de 15 regras do markdownlint e regras de tipografia chinesa, gerando um relatório detalhado por linha e permitindo a auto-correção automática de problemas seguros, como espaços finais e linhas em branco consecutivas.
Quando usar
- •Antes de publicar documentações técnicas ou arquivos README em repositórios Git para garantir consistência visual.
- •Ao revisar textos que misturam caracteres chineses e latinos para ajustar o espaçamento tipográfico automaticamente.
- •Para padronizar marcadores de listas, quebras de linha e espaçamentos em lote sem alterar a estrutura do conteúdo.
Como funciona
- •Insira o texto Markdown no campo de entrada e selecione o conjunto de regras desejado (Padrão, Estrito ou Brando).
- •O motor tokeniza o documento em blocos como títulos, listas, tabelas e cercas de código para aplicar as validações.
- •O validador identifica desvios como títulos duplicados, falta de linguagem em blocos de código ou espaçamentos incorretos.
- •Se a opção de auto-correção estiver ativa, o utilitário corrige automaticamente os problemas seguros e gera um relatório com os alertas restantes.
Casos de uso
Exemplos
1. Correção de README com marcadores mistos e código sem linguagem
Desenvolvedor de Software- Contexto
- Um desenvolvedor precisa enviar um projeto para o GitHub, mas o arquivo README.md possui marcadores de lista inconsistentes e blocos de código sem a tag de linguagem.
- Problema
- O arquivo contém marcadores '*' e '-' misturados, além de blocos de código sem especificação de linguagem, violando as regras MD004 e MD040.
- Como usar
- Cole o conteúdo do README no campo de texto, selecione o conjunto de regras 'Padrão' e ative a opção 'Auto-corrigir problemas seguros'.
- Configuração de exemplo
-
ruleSet: "default", autoFix: true - Resultado
- Os marcadores de lista são unificados para '-', os espaços extras no final das linhas são removidos e o relatório aponta a linha exata onde falta definir a linguagem do bloco de código.
2. Ajuste de espaçamento em documentação bilíngue
Redator Técnico- Contexto
- Um redator está preparando um manual técnico em chinês e inglês, mas a falta de espaços entre os caracteres de diferentes idiomas prejudica a legibilidade.
- Problema
- O texto possui termos em inglês colados a caracteres chineses (ex: '使用Python3') e títulos sem linhas em branco ao redor.
- Como usar
- Insira o texto Markdown no editor, selecione o conjunto de regras 'Padrão' com a auto-correção ativada.
- Configuração de exemplo
-
ruleSet: "default", autoFix: true - Resultado
- O verificador aplica a regra CN001 inserindo espaços (ex: '使用 Python 3') e adiciona as linhas em branco necessárias antes e depois dos títulos.
Testar com amostras
markdownHubs relacionados
FAQ
O que a opção de auto-correção faz?
Ela corrige automaticamente problemas seguros e determinísticos, como remoção de espaços finais, ajuste de linhas em branco e padronização de marcadores de lista.
Quais conjuntos de regras posso escolher?
Você pode escolher entre Padrão (15 regras MDlint + 2 de tipografia chinesa), Estrito (validações adicionais como comprimento de linha) e Brando (apenas erros críticos).
O verificador altera a estrutura do meu documento?
Não, ele realiza apenas correções de estilo e formatação de texto, mantendo a estrutura e o conteúdo original intactos.
O que é a regra de tipografia chinesa CN001?
É uma regra que verifica e insere um espaço apropriado entre caracteres chineses e caracteres latinos ou dígitos.
Como o validador lida com blocos de código?
Ele verifica se os blocos de código possuem a indicação da linguagem de programação correspondente (regra MD040) e se há linhas em branco adequadas ao redor deles.