Documentação bilíngue (Português/Inglês) do Synesis Language, construída com Quarto e otimizada para GitHub Pages.
synesis-docs-sources/
├── pt/ # Versão em Português
│ ├── _quarto.yml # Configuração PT
│ ├── index.qmd
│ ├── about.qmd
│ ├── explanation/ # Explicações aprofundadas
│ │ ├── posicionamento_arquitetural.qmd
│ │ ├── por_que_estrutura_importa.qmd
│ │ ├── guia_sincero.qmd
│ │ ├── synesis_escrituras.qmd
│ │ ├── knowledge_graphs.qmd
│ │ ├── ideas.qmd
│ │ ├── show_case.qmd
│ │ ├── exemplos_codificacao.qmd
│ │ ├── codificacao_assistida_IA.qmd
│ │ ├── codificacao_assistida_IA_metricas.qmd
│ │ ├── como_surgiu.qmd
│ │ └── dsap.qmd
│ ├── howto/ # Guias práticos
│ │ ├── guia_profissionais.qmd
│ │ ├── definir_ontologia.qmd
│ │ ├── criar_chains.qmd
│ │ └── exportar_neo4j.qmd
│ ├── reference/ # Referência da linguagem
│ │ ├── guia_referencia.qmd
│ │ ├── synesis_load.qmd
│ │ └── fluxo_compilacao.qmd
│ └── tutorials/ # Tutoriais
│ ├── getting-started.qmd
│ ├── guia_pesquisadores.qmd
│ └── synesis_explorer_tutorial.qmd
├── en/ # Versão em Inglês
│ ├── _quarto.yml # Configuração EN
│ ├── index.qmd
│ ├── about.qmd
│ ├── explanation/
│ │ ├── guia_sincero.qmd
│ │ ├── knowledge_graphs.qmd
│ │ └── ideas.qmd
│ ├── howto/
│ │ ├── guia_profissionais.qmd
│ │ └── exportar_neo4j.qmd
│ ├── ecossistema/
│ │ └── synesis2neo4j_en.qmd
│ ├── reference/
│ │ ├── guia_referencia.qmd
│ │ └── synesis_load.qmd
│ └── tutorials/
│ ├── guia_pesquisadores.qmd
│ └── synesis_explorer_tutorial.qmd
├── images/ # Assets visuais (25 imagens)
├── synesis-landing/ # Páginas de landing
├── index.qmd # Página raiz com redirecionamento automático
├── _quarto.yml # Configuração global
├── synesis.scss # Tema customizado
├── synesis.xml # Syntax highlighting para Synesis Language
├── references.bib # Bibliografias
├── apa.csl # Estilo de citação APA
├── build.bat # Script de build (Windows)
├── build.sh # Script de build (Linux/macOS)
└── _site/ # Output (GitHub Pages)
├── .nojekyll # Necessário para GitHub Pages
├── index.html # Redireciona automaticamente
├── pt/ # Site em Português
└── en/ # Site em Inglês
Windows:
build.batLinux/macOS:
bash build.shOu manualmente:
cd pt && quarto render && cd ..
cd en && quarto render && cd ..
quarto render index.qmd --to html --output-dir _sitePortuguês:
cd pt
quarto previewInglês:
cd en
quarto preview-
Configure o repositório:
- Vá em Settings > Pages
- Source: Deploy from a branch
- Branch:
main - Folder:
/_site
-
O arquivo
.nojekylljá está configurado automaticamente no build -
Push das alterações:
git add _site
git commit -m "Update documentation"
git pushO index.qmd detecta o idioma do navegador e redireciona para /pt/ ou /en/
Cada versão (PT/EN) tem um menu de idiomas no canto superior direito da navbar.
O conteúdo segue o framework Diataxis, organizado em 4 tipos:
- Tutorials — aprendizado orientado a objetivos
- How-to Guides — guias para tarefas específicas
- Explanation — compreensão aprofundada
- Reference — informação técnica precisa
- Tema customizado:
synesis.scss - Syntax highlighting para Synesis Language:
synesis.xml - Bibliografias:
references.bibcom estilo APA (apa.csl)
- Crie o arquivo
.qmdna pasta correta empt/e (opcionalmente)en/ - Adicione a referência em
pt/_quarto.ymle/ouen/_quarto.yml:
website:
sidebar:
contents:
- nova-pagina.qmd- Execute
quarto previewoubuild.batpara validar
- Quarto >= 1.5
- Git (para deploy)