21 Projeto novo
Um livro novo não precisa começar do zero: pode começar de um modelo, um repositório com a estrutura de pastas, o tema, as fontes, a localização, os validadores e o workflow já prontos. O modelo existe para que cada livro nasça idêntico aos anteriores em estilo e organização. Este livro nasceu assim, de um modelo particular do autor; o leitor monta o seu a partir de um livro que já funcione, trocando o conteúdo por exemplos e marcando o que muda de livro para livro.
21.1 Criar o repositório
Para que um repositório sirva de modelo, abra Settings no GitHub e marque Template repository. A partir daí, cada livro novo começa no modelo, com Use this template → Create a new repository. Dê ao repositório o nome curto que será o caminho do livro no site (apostila, minha-tese, manual-de-campo). Clone-o e, em Settings → Pages, configure a origem como GitHub Actions.
21.2 O que trocar
O modelo marca com <TODO> tudo o que muda de livro para livro. Para encontrar as ocorrências:
grep -rn "TODO" . --include="*.qmd" --include="*.yml" --include="*.html"| Arquivo | O que trocar |
|---|---|
_quarto.yml |
título, subtítulo, edição, descrição, palavras-chave, site-url, repo-url |
index.qmd |
prefácio: sobre o livro, públicos |
creditos.qmd |
título, repositório, ano, crédito da capa, ficha bibliográfica, citação sugerida |
images/capa.html |
título, subtítulo, edição; depois rodar code/make_cover.sh |
references/references.bib |
substituir a entrada de exemplo pela bibliografia real |
capitulos/, atividades/, apendices/ |
substituir os exemplos pelo conteúdo |
Autor, licença, rodapé, fontes, tema, favicon e _language-pt.yml já vêm preenchidos e em geral não mudam.
21.3 Renomear as partes
A pasta capitulos/parte-1-exemplo/ é renomeada conforme o conteúdo, e o sumário em _quarto.yml acompanha. A convenção é parte-N-nome-curto/, com os arquivos numerados de forma contínua pelo livro.
21.4 Manter o modelo atualizado
O modelo é uma cópia, não um vínculo: uma melhoria feita no tema de um livro não chega aos outros sozinha. O fluxo é levar a melhoria de volta ao modelo e, de lá, aos livros existentes, copiando os arquivos sincronizados (theme-editorial.scss, styles.css, _language-pt.yml, publish.yml e os scripts de code/). Assim, um rodapé novo ou um ajuste nas notas de rodapé, nascido em um livro, passa ao modelo e dele aos demais.
- Todo livro nasce de um repositório modelo, marcado como Template repository no GitHub, com “Use this template”.
- O que muda está marcado com
<TODO>: metadados, prefácio, créditos, capa, bibliografia, conteúdo. - Partes e arquivos seguem a convenção
parte-N-nome/NN-slug.qmd. - Melhorias de estilo voltam ao modelo e dele aos outros livros.