Skip to content

Commit aad2827

Browse files
update docs
1 parent daa0a82 commit aad2827

File tree

10 files changed

+2541
-273
lines changed

10 files changed

+2541
-273
lines changed

docs/README.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# JSON Canvas Viewer - Documentação
2+
3+
Documentação técnica completa do JSON Canvas Viewer.
4+
5+
## Acesse a Documentação
6+
7+
📚 **[https://yourusername.github.io/jsoncanvasviewer/](https://yourusername.github.io/jsoncanvasviewer/)**
8+
9+
---
10+
11+
## Executar Localmente
12+
13+
Esta documentação usa Jekyll para GitHub Pages.
14+
15+
### Pré-requisitos
16+
17+
```bash
18+
# macOS
19+
brew install ruby
20+
21+
# Ubuntu
22+
sudo apt install ruby-full
23+
24+
# Instalar Bundler
25+
gem install bundler
26+
```
27+
28+
### Setup e Execução
29+
30+
```bash
31+
cd docs
32+
bundle install
33+
bundle exec jekyll serve
34+
```
35+
36+
Acesse: `http://localhost:4000`
37+
38+
---
39+
40+
## Estrutura
41+
42+
```
43+
docs/
44+
├── _config.yml # Configuração Jekyll
45+
├── _layouts/
46+
│ └── default.html # Layout dark mode
47+
├── assets/css/
48+
│ └── style.scss # Estilos minimalistas
49+
├── index.md # Página inicial
50+
├── architecture.md # Arquitetura
51+
├── components.md # Componentes
52+
├── json-spec.md # Especificação JSON
53+
├── elements.md # Elementos
54+
├── rendering.md # Renderização
55+
├── interactivity.md # Interatividade
56+
├── technical-decisions.md # Decisões técnicas
57+
├── installation.md # Instalação
58+
└── contributing.md # Contribuindo
59+
```
60+
61+
---
62+
63+
## Configurar GitHub Pages
64+
65+
1. Vá em **Settings** > **Pages**
66+
2. Source: **Deploy from a branch**
67+
3. Branch: `main` / Folder: `/docs`
68+
4. **Save**
69+
5. Aguarde 2-5 minutos
70+
6. Acesse: `https://seu-usuario.github.io/jsoncanvasviewer/`
71+
72+
---
73+
74+
## Contribuir
75+
76+
Para melhorar a documentação:
77+
78+
1. Fork o repositório
79+
2. Edite arquivos `.md` em `/docs`
80+
3. Teste localmente com Jekyll
81+
4. Submeta Pull Request
82+
83+
---
84+
85+
**Made with 💙 by [Conty Team](https://site.appconty.com)**
86+

docs/_layouts/default.html

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
<!DOCTYPE html>
2+
<html lang="pt-BR">
3+
<head>
4+
<meta charset="UTF-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6+
<meta name="description" content="{{ page.description | default: site.description }}">
7+
<title>{{ page.title | default: site.title }}</title>
8+
<link rel="stylesheet" href="{{ '/assets/css/style.css' | relative_url }}">
9+
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
10+
<script>
11+
mermaid.initialize({
12+
startOnLoad: true,
13+
theme: 'dark',
14+
themeVariables: {
15+
darkMode: true,
16+
primaryColor: '#ffffff',
17+
primaryTextColor: '#e8e8e8',
18+
primaryBorderColor: '#2a2a2a',
19+
lineColor: '#666666',
20+
secondaryColor: '#1a1a1a',
21+
tertiaryColor: '#111111',
22+
background: '#0a0a0a',
23+
mainBkg: '#111111',
24+
textColor: '#e8e8e8'
25+
}
26+
});
27+
</script>
28+
</head>
29+
<body>
30+
<header>
31+
<div class="container">
32+
<h1><a href="{{ '/' | relative_url }}">JSON Canvas Viewer</a></h1>
33+
<nav>
34+
<ul>
35+
{% for link in site.nav_links %}
36+
<li>
37+
<a href="{{ link.url | relative_url }}" {% if page.url == link.url %}class="active"{% endif %}>
38+
{{ link.title }}
39+
</a>
40+
</li>
41+
{% endfor %}
42+
</ul>
43+
</nav>
44+
</div>
45+
</header>
46+
47+
<main class="container">
48+
{{ content }}
49+
</main>
50+
51+
<footer>
52+
<div class="container">
53+
<p>JSON Canvas Viewer Documentation</p>
54+
<p style="margin-top: 0.5rem; font-size: 0.85rem;">
55+
Made with 💙 by <a href="https://site.appconty.com" target="_blank">Conty Team</a>
56+
</p>
57+
{% if site.repository %}
58+
<p style="margin-top: 0.5rem;">
59+
<a href="https://github.com/{{ site.repository }}" target="_blank">View on GitHub</a>
60+
</p>
61+
{% endif %}
62+
</div>
63+
</footer>
64+
</body>
65+
</html>
66+

0 commit comments

Comments
 (0)