An open API service indexing awesome lists of open source software.

https://github.com/juninmd/meu-livro-2


https://github.com/juninmd/meu-livro-2

Last synced: 3 days ago
JSON representation

Awesome Lists containing this project

README

          

# šŸ“– Meu Livro 2 - Documentation & Content System

![VitePress](https://img.shields.io/badge/docs-VitePress-blue.svg)
![Python Scripts](https://img.shields.io/badge/automation-Python-green.svg)
![Status](https://img.shields.io/badge/status-in%20progress-yellow.svg)

**Meu Livro 2** é um sistema de documentação e criação de conteúdo estruturado, utilizando **VitePress** para a interface de leitura e scripts **Python** para automação de mídia e verificação de integridade.

---

## ✨ Recursos Principais

* šŸ“š **Leitura Moderna:** Interface limpa e responsiva baseada em VitePress.
* šŸ–¼ļø **Automação de MĆ­dia:** Scripts integrados para geração de imagens via IA (DALL-E, Stable Diffusion).
* 🧪 **Verificação de Capítulos:** Sistema de validação por screenshots e scripts Python para garantir a qualidade do conteúdo.
* ⚔ **Build RÔpido:** Workflow otimizado para desenvolvimento e visualização instantânea.
* šŸ› ļø **Organização Modular:** Estrutura clara dividida entre documentação (docs), scripts e assets.

---

## šŸ› ļø Tecnologias Utilizadas

| Camada | Tecnologia |
| :--- | :--- |
| **Documentação** | [VitePress](https://vitepress.dev/) |
| **Automação** | Python 3.x |
| **Media Gen** | OpenAI DALL-E / Stable Diffusion Scripts |
| **JS Engine** | Node.js / pnpm |

---

## šŸš€ Como Iniciar

### PrƩ-requisitos

* Node.js (v18+)
* Python (v3.10+)

### Instalação

```bash
# Clone o repositório
git clone git@github.com:juninmd/meu-livro-2.git

# Instale dependĆŖncias Node
npm install

# Instale dependĆŖncias Python (opcional, para scripts de mĆ­dia)
pip install -r scripts/requirements.txt
```

### Comandos de Documentação

```bash
# Iniciar modo de desenvolvimento
npm run docs:dev

# Gerar build estƔtico
npm run docs:build

# Preview do build
npm run docs:preview
```

---

## šŸ“‚ Estrutura do Projeto

```text
meu-livro-2/
ā”œā”€ā”€ docs/ # ConteĆŗdo Markdown do livro
ā”œā”€ā”€ scripts/ # Automação de imagens e verificação
│ ā”œā”€ā”€ generate_*.py # Geração de mĆ­dia via IA
│ └── verify_*.py # Validação de capĆ­tulos
ā”œā”€ā”€ .github/ # Workflows de CI/CD
└── public/ # Ativos estĆ”ticos e imagens do livro
```

---

## 🧪 Verificação & Qualidade

O projeto utiliza screenshots de verificação para acompanhar o progresso dos capítulos. Veja a pasta raiz para arquivos como `verification_chapter_15.png` que validam o estado visual do projeto.

---

## šŸ¤ Contribuição

Para contribuir:
1. Revise as diretrizes no [AGENTS.md](./AGENTS.md).
2. Siga o fluxo de trabalho sugerido no [ROADMAP.md](./ROADMAP.md).
3. Abra um Pull Request detalhando suas alteraƧƵes.

---

## šŸ“„ LicenƧa

Distribuƭdo sob a licenƧa **ISC**.

---

*"Writing is the ultimate form of thinking. Build the foundation, inspire the reader."*