O Quarkdown é uma ferramenta moderna de composição baseada em Markdown que amplia o poder do CommonMark e do GitHub Flavored Markdown (GFM). Ele introduz funções, variáveis e bibliotecas padrão que permitem aos usuários criar conteúdo dinâmico que gera facilmente apresentações interativas, páginas da Web ou livros prontos para impressão. O Quarkdown suporta compilação rápida e visualização em tempo real para desenvolvedores, escritores e designers. Os usuários podem usar a sintaxe simples do Markdown para obter layouts complexos, além de oferecer suporte à saída de PDF e a bibliotecas personalizadas. O projeto é de código aberto, bem documentado e tem uma comunidade ativa para usuários que precisam criar documentos complexos com eficiência.
Lista de funções
- Geração de conteúdo dinâmicoSuporte a funções e variáveis para criar conteúdo interativo, como saudações dinâmicas ou declarações condicionais.
- Visualização em tempo real: através de
-p
responder cantando-w
para atualizar automaticamente o conteúdo e exibi-lo ao vivo em seu navegador. - Saída em PDF: Uso
--pdf
compila o documento em um arquivo PDF pronto para impressão. - Suporte à biblioteca padrãoFunções: fornece funções como construção de layout, operações matemáticas, instruções condicionais e loops.
- função personalizadaMarkdown: Os usuários podem definir suas próprias funções e variáveis para ampliar a funcionalidade do Markdown.
- Compilação de vários arquivosSuporte a projetos com vários arquivos: especifique o arquivo raiz para compilar o projeto inteiro.
- Modo REPL interativo: através de
quarkdown repl
Entre no modo interativo para testar rapidamente o código. - Carregamento de biblioteca externa: através de
-l
talvez--libs
Carregar bibliotecas externas para aumentar a funcionalidade. - Vários alvos de renderizaçãoSuporte a HTML e outros formatos de renderização para saída flexível de conteúdo.
Usando a Ajuda
Processo de instalação
O Quarkdown é uma ferramenta de linha de comando com um processo de instalação simples. Veja a seguir as etapas detalhadas:
- Garantir o meio ambienteQuarkdown: O Quarkdown requer a instalação do Node.js (recomenda-se a versão mais recente do LTS). Executar
node -v
Verifique se o Node.js está instalado. - armazém de clonesVisite o repositório do GitHub (https://github.com/iamgio/quarkdown) e execute o seguinte comando para clonar o projeto:
git clone https://github.com/iamgio/quarkdown.git
- Instalação de dependências: Vá para o diretório do projeto e execute:
cd quarkdown npm install
- instalação globalSe você quiser usar o comando Quarkdown globalmente, execute:
npm install -g .
- Verificar a instalação: Executar
quarkdown --version
Verifique se a instalação foi bem-sucedida.
Uso
O Quarkdown opera a partir da linha de comando, e os principais comandos são quarkdown c <file.qmd>
Essa é a primeira etapa do processo de compilação de um arquivo Markdown. Veja a seguir as principais funções e o fluxo de operação:
1. compilação de arquivos individuais
Para compilar um arquivo Quarkdown (como o arquivo example.qmd
), executar:
quarkdown c example.qmd
O arquivo de saída é salvo por padrão na pasta ./output
diretório. Para especificar o diretório de saída, use -o
::
quarkdown c example.qmd -o ./my-output
2. visualização em tempo real
O Quarkdown oferece suporte à visualização em tempo real, o que é adequado para ajustar rapidamente o conteúdo. Execute o seguinte comando para iniciar a visualização:
quarkdown c example.qmd -p -w
-p
Iniciar a visualização do navegador e abrir o navegador padrão automaticamente.-w
Monitoramento de alterações de arquivos e recompilação automática.
combinando-p -w
Você pode atualizar instantaneamente o efeito de visualização após salvar, o que é adequado para ajustar dinamicamente apresentações ou páginas da Web.
3. geração de PDF
Para exportar um documento para PDF, adicione --pdf
Parâmetros:
quarkdown c example.qmd --pdf
Os arquivos PDF gerados são salvos no diretório de saída e são adequados para imprimir livros ou compartilhar documentos. Para obter mais configurações de PDF, consulte a documentação oficial (quarkdown.com/docs).
4. modelo REPL interativo
Deseja testar a sintaxe do Quarkdown rapidamente? Use o modo REPL:
quarkdown repl
Uma vez no ambiente interativo, você pode inserir o código do Quarkdown diretamente, por exemplo:
.function {greet} to from: **Hello, .to** from .from!
.greet {world} from:{iamgio}
O resultado de saída é:Hello, world from iamgio!
. Esse modo é adequado para aprendizado e depuração.
5. uso de bibliotecas padrão e funções personalizadas
O Quarkdown oferece uma biblioteca padrão avançada com suporte para layout, operações matemáticas e instruções condicionais. Por exemplo, a criação de uma lista dinâmica:
.for {item} in {apple, banana, orange}:
- .item
.endfor
O resultado é:
- maçã
- banana
- laranja
O usuário também pode definir funções personalizadas. Exemplo:
.function {welcome} name: Welcome, .name, to Quarkdown!
.welcome {Alice}
Saída:Welcome, Alice, to Quarkdown!
. As funções personalizadas podem ser salvas como bibliotecas para reutilização em outros projetos.
6. projetos com vários documentos
Para projetos complexos, o Quarkdown oferece suporte à compilação de vários arquivos. Certifique-se de especificar o arquivo raiz (por exemplo main.qmd
), ele incluirá automaticamente outros arquivos:
quarkdown c mock/main.qmd -p
Exemplos de projetos mock
Inclui uma variedade de elementos visuais para aprender os recursos do Quarkdown.
7. carregamento de bibliotecas externas
Se você precisar usar uma biblioteca externa, especifique o diretório da biblioteca:
quarkdown c example.qmd -l ./my-libs
O caminho padrão da biblioteca é <install dir>/lib/qmd
. Os usuários podem criar e compartilhar suas próprias bibliotecas.
8. configurações de destino de renderização
O Quarkdown gera HTML por padrão, mas isso pode ser alterado por meio da opção -r
Especifica outros alvos de renderização:
quarkdown c example.qmd -r html
Consulte a documentação oficial para obter mais opções de renderização.
Operação da função em destaque
- conteúdo dinâmicoO principal recurso do Quarkdown é o suporte a funções e variáveis. Os usuários podem usar a função
.function
Defina funções que combinem loops de biblioteca padrão e instruções condicionais para gerar conteúdo dinâmico. Por exemplo, uso de instrução condicional:.if {condition} == true: Content displayed if true .else: Content displayed if false .endif
- Exemplo simulado: Cortesia de Quarkdown
mock
Exemplo de projeto que demonstra elementos visuais e efeitos tipográficos. Executarquarkdown c mock/main.qmd -p
Ver demonstração completa. - Contribuições da comunidadeOs usuários podem participar do desenvolvimento de recursos enviando problemas ou solicitações pull via GitHub. Referências
CONTRIBUTING.md
Obtenha o guia.
Mais recursos e documentação detalhada estão disponíveis em quarkdown.com/docs.
cenário do aplicativo
- Documentação técnica
Os desenvolvedores podem usar o Quarkdown para escrever documentação técnica dinâmica. Gere documentação complexa com lógica condicional ou loops por meio de funções e variáveis. Por exemplo, gerar automaticamente tabelas ou listas para documentação de API. - Apresentações interativas
Educadores ou palestrantes podem usar o Quarkdown para criar apresentações de slides interativas. Combine visualizações em tempo real com ajustes rápidos de conteúdo para apresentações em salas de aula ou conferências. - layout do livro
Os autores podem compilar arquivos Markdown em livros em PDF prontos para impressão, adequados para autopublicação ou manuais técnicos. - blog pessoal
Os blogueiros podem aproveitar os recursos dinâmicos do Quarkdown para criar páginas da Web que incluam elementos interativos, como saudações dinâmicas ou conteúdo personalizado.
QA
- Quais padrões de Markdown são compatíveis com o Quarkdown?
O Quarkdown é baseado no CommonMark e no GitHub Flavored Markdown (GFM) e o amplia com funções, variáveis e recursos de biblioteca padrão. A sintaxe padrão do Markdown é totalmente compatível. - Como depurar o código Quarkdown?
fazer uso dequarkdown repl
Entre no modo interativo e teste o código linha por linha. As mensagens de erro são exibidas no terminal, o que facilita a localização do problema. - É necessário ter experiência em programação?
Não. A sintaxe do Quarkdown é simples, e os usuários familiarizados com o Markdown podem começar rapidamente. As bibliotecas padrão e a documentação oferecem suporte adequado. - Como exportar formatos diferentes?
A saída padrão é HTML; use o--pdf
Outros formatos de renderização estão disponíveis em-r
especificado, consulte a documentação para obter detalhes. - Como faço para me envolver em minha comunidade?
Visite os repositórios do GitHub para enviar problemas ou solicitações pull.CONTRIBUTING.md
Obtenha um guia para contribuir.