A visualização do Markdown online e a criação de documentos locais respondem a diferentes questões. Uma visualização online pergunta: "Este Markdown é renderizado corretamente numa visualização geral e existem problemas óbvios de criação?" Uma compilação de documentos locais pergunta: "Este conteúdo funciona dentro do nosso sistema de documentação real?"
Ambos são úteis. O erro é pedir a uma camada que faça o trabalho da outra camada. O Markdown Validator do Converty é uma verificação rápida e antecipada. A compilação dos seus documentos locais continua a ser a verificação final do ambiente quando a renderização específica da plataforma é importante.
Utilize a pré-visualização online para uma revisão rápida do rascunho
Uma pré-visualização online do Markdown é útil quando o conteúdo ainda está em movimento. Uma secção README, nota de lançamento, entrada de changelog ou documento de suporte podem ser verificados antes de se tornar um pedido pull ou compilação de documentos.
A visualização ajuda a captar:
- mesas com aspeto quebrado
- problemas de estrutura do título
- texto alternativo ausente
- links vazios
- cercas de código não rotuladas
- HTML em bruto que precisa de revisão
Esta é a fase em que o feedback rápido é mais importante do que a precisão total do ambiente.
Utilize uma compilação de documentos locais para a renderização final
Uma compilação de documentos locais é a camada certa quando a plataforma final tem um comportamento personalizado. Muitos sistemas de documentos transformam o Markdown através de componentes, encaminhamento, realce de sintaxe, chamadas personalizadas ou estilos específicos de estrutura.
Apenas a compilação local pode mostrar se o conteúdo funciona nesse ambiente. Se uma página utilizar componentes personalizados, snippets importados ou renderização específica do produto, a visualização do browser terá de vir em primeiro lugar, e não em último lugar.
O melhor fluxo de trabalho utiliza ambos os
Utilize a visualização online para limpar a fonte. Utilize a compilação local para verificar o destino.
Esta sequência poupa tempo porque a construção local já não deteta erros básicos do Markdown. Pode concentrar-se no comportamento específico da plataforma que é capaz de testar exclusivamente.
Para um fluxo de trabalho prático de revisão antecipada, leia Como visualizar GitHub-Flavored Markdown antes de confirmar. Para transferências de produtos e documentos, leia Como as equipas de produtos e documentos podem rever o markdown sem perder a formatação.
Abra o Markdown Validator quando necessitar da camada de visualização online rápida antes de mover o mesmo conteúdo para uma compilação de documentos locais ou visualização de publicação final.
