77 lines
2.7 KiB
Markdown
Executable File
77 lines
2.7 KiB
Markdown
Executable File
# Gerador de Guias DOCX e PDF
|
|
|
|
Este projeto automatiza a conversão de guias de marketing escritos em Markdown para documentos `.docx` e `.pdf` com branding profissional.
|
|
|
|
## Funcionalidades
|
|
|
|
- **Conversão de Markdown**: Converte ficheiros `.md` para `.docx` e `.pdf`.
|
|
- **Branding Automático**: Aplica um template DOCX com cabeçalhos, rodapés e estilos pré-definidos.
|
|
- **Índice (TOC)**: Gera automaticamente um índice no início do documento, intitulado "Índice".
|
|
- **Preservação de Links**: Mantém todos os hyperlinks do ficheiro Markdown original.
|
|
- **Processamento em Lote**: Consegue processar um único ficheiro ou uma pasta inteira de ficheiros `.md`.
|
|
|
|
## Pré-requisitos
|
|
|
|
Para utilizar este projeto, precisa de ter as seguintes ferramentas instaladas no seu sistema:
|
|
|
|
1. **Pandoc**: Para a conversão de documentos.
|
|
- [Instruções de Instalação](https://pandoc.org/installing.html)
|
|
2. **LibreOffice**: Para a conversão de DOCX para PDF.
|
|
- No Ubuntu/Debian: `sudo apt install libreoffice`
|
|
3. **Python 3**: Com o módulo `venv`.
|
|
- No Ubuntu/Debian: `sudo apt install python3 python3-venv`
|
|
|
|
## Como Utilizar
|
|
|
|
### 1. Configuração do Ambiente
|
|
|
|
Primeiro, clone o repositório e navegue para a pasta do projeto. Em seguida, crie um ambiente virtual e instale as dependências Python.
|
|
|
|
```bash
|
|
# Criar o ambiente virtual
|
|
python3 -m venv .venv
|
|
|
|
# Instalar as dependências do projeto
|
|
./.venv/bin/pip install -r scripts/requirements.txt
|
|
```
|
|
|
|
### 2. Preparar o Template (Opcional)
|
|
|
|
O script utiliza um template otimizado para Pandoc (`scripts/template_pandoc.docx`). Se o template mestre (`scripts/template_mestre.docx`) for alterado, precisa de recriar o template para Pandoc.
|
|
|
|
Pode fazê-lo de duas formas:
|
|
|
|
- **Manualmente, executando o script:**
|
|
```bash
|
|
./.venv/bin/python3 scripts/create_pandoc_template.py
|
|
```
|
|
- **Automaticamente, ao converter:**
|
|
Adicione a flag `--recreate-template` ao comando de conversão.
|
|
|
|
### 3. Executar a Conversão
|
|
|
|
Para converter os guias, execute o script `converter_final.py`, passando o caminho para o ficheiro ou pasta que deseja processar.
|
|
|
|
**Sintaxe do Comando:**
|
|
```bash
|
|
./.venv/bin/python3 scripts/converter_final.py [CAMINHO_PARA_FICHEIRO_OU_PASTA] [OPÇÕES]
|
|
```
|
|
|
|
**Exemplos:**
|
|
|
|
- **Converter um único ficheiro:**
|
|
```bash
|
|
./.venv/bin/python3 scripts/converter_final.py "Guias/SEO.md"
|
|
```
|
|
|
|
- **Converter todos os ficheiros numa pasta:**
|
|
```bash
|
|
./.venv/bin/python3 scripts/converter_final.py Guias/
|
|
```
|
|
|
|
- **Converter e forçar a recriação do template:**
|
|
```bash
|
|
./.venv/bin/python3 scripts/converter_final.py Guias/ --recreate-template
|
|
```
|
|
|
|
Os ficheiros processados serão guardados nas pastas `output/docx` e `output/pdf`. |