UStackUStack
Quarkdown icon

Quarkdown

Quarkdown é um sistema moderno open-source de diagramação em Markdown com pré-visualização reativa e múltiplos modos por doctype para criar saídas.

Quarkdown

O que é Quarkdown?

Quarkdown é um sistema moderno, open-source, de diagramação baseado em Markdown para escrever documentos com um fluxo de trabalho similar ao LaTeX. Seu propósito principal é permitir que você crie conteúdo em Markdown e o compile em saídas formatadas para artigos, apresentações, bases de conhecimento e sites estáticos.

O site posiciona o Quarkdown como um único sistema de autoria que pode substituir múltiplas ferramentas dependendo do tipo de saída, incluindo fluxos de trabalho de documentos similares ao LaTeX e formatos comuns de documentação/wiki.

Principais Recursos

  • Autoria priorizando Markdown para escrever conteúdo em um formato projetado para legibilidade e edição rápida.
  • Extensões para formatação e comportamento adicionais além do Markdown simples, descritas como “extensões para alcançar mais”.
  • Múltiplos tipos de saída selecionados via “doctype” do documento (ex.: paged, plain, docs, slides) para diferentes entregáveis.
  • Pré-visualização reativa com resultados ao vivo enquanto digita, suportada por “compilação ultrarrápida e pré-visualização ao vivo”.
  • Capacidades de script descritas como “Turing completas” e destinadas a ajudar a reutilizar seu fluxo de trabalho em vez de repetir.

Como Usar o Quarkdown

Comece escrevendo seu conteúdo em Markdown, depois escolha um tipo de documento apropriado usando a configuração .doctype {…} do Quarkdown (por exemplo, artigo/relatório paginado, layout de nota/conhecimento simples, conteúdo no estilo docs ou slides). Enquanto edita, use o feedback de pré-visualização/compilação ao vivo para ver como sua saída é renderizada.

Se precisar de formatação especializada ou estruturas repetidas, use extensões e construções de script do Quarkdown (a documentação mostra exemplos como definir funções e renderizar blocos repetidos) para gerar seções consistentes a partir de lógica reutilizável.

Casos de Uso

  • Escrever um artigo de pesquisa ou relatório usando um tipo de documento paginado (.doctype {paged}) para layout no estilo artigo/livro/relatório.
  • Manter uma base de conhecimento pessoal ou site estático simples usando um doctype simples (.doctype {plain}) quando quiser notas e publicação direta.
  • Construir uma wiki de equipe ou conjunto de documentação técnica usando saída orientada a docs (.doctype {docs}), adequada para bases de conhecimento maiores e leitura no estilo documentação.
  • Preparar materiais de aula ou palestras usando um doctype de slides (.doctype {slides}) para formatar conteúdo para apresentações interativas.
  • Gerar estruturas visuais repetidas ou baseadas em dados por meio de script e extensões (os exemplos do site mostram funções e “cards” ou blocos repetidos com imagens e metadados).

FAQ

  • Que tipos de saídas o Quarkdown suporta? O site descreve modos de doctype para artigos/livros/relatórios paginados, notas simples/sites estáticos simples, bases de conhecimento no estilo docs e slides para aulas e palestras.

  • O Quarkdown oferece pré-visualização enquanto escrevo? Sim. Ele anuncia pré-visualização ao vivo com compilação rápida para ver resultados enquanto digita.

  • O Quarkdown é compatível com fluxos de trabalho no estilo LaTeX? A página afirma que o Quarkdown substitui o LaTeX para artigos/livros/relatórios, indicando que visa esse fluxo de documentos em vez de exigir uma cadeia de ferramentas LaTeX separada.

  • Qual o papel das extensões e do script? As extensões são descritas como uma forma de alcançar formatação e comportamento além do Markdown básico, enquanto as capacidades de script são descritas como Turing completas para reutilizar lógica de fluxo de trabalho e evitar repetições.

  • O Quarkdown é open source? Sim. A meta descrição e o texto da página o chamam de “open-source”.

Alternativas

  • Uma cadeia de ferramentas de diagramação LaTeX/Typst para preparação de documentos tradicionais quando preferir uma linguagem ou ecossistema dedicado de diagramação.
  • Uma abordagem de gerador de site estático para documentação/wiki (por exemplo, ferramentas na categoria “docs”) se seu objetivo principal for publicar documentação estruturada em vez de usar Markdown mais diagramação com múltiplos modos de doctype.
  • Um framework de apresentações baseado em Markdown para autoria de slides se precisar principalmente de decks de slides e menos de um sistema unificado para artigos e bases de conhecimento.
  • Uma plataforma de wiki/notas de propósito geral se quiser um ambiente de edição e publicação totalmente gerenciado em vez de um fluxo de trabalho orientado a diagramação impulsionado por Markdown.
Quarkdown | UStack