🚀 HubAtlas

Uma engine de documentação moderna, extensível e agnóstica de framework.

O HubAtlas é um motor de documentação focado em performance, arquitetura limpa e extensibilidade. Ele transforma arquivos Markdown em uma estrutura navegável pronta para ser utilizada com qualquer servidor ou framework.

✨ Objetivo

Criar uma engine de documentação:

• 🔹 Independente de framework (Next, Vite, Fastify, etc.)
• 🔹 Modular e extensível
• 🔹 Focada em arquitetura
• 🔹 Preparada para crescer como ecossistema

🧠 O que o HubAtlas faz

📂 Ler arquivos

• Lê arquivos .md
• Aceita arquivo único ou diretório
• Suporte a estrutura aninhada

🌐 Resolver rotas

• Converte estrutura de pastas em rotas
• index.md → /
• guide/setup.md → /guide/setup
• Sistema determinístico e previsível

🌳 Criar árvore de navegação

• Gera estrutura hierárquica automaticamente
• Ideal para sidebar dinâmica
• Base para sistema de busca futura

Exemplo de estrutura gerada:

{
  path: "/guide",
  children: [
    { path: "/guide/setup" },
    { path: "/guide/config" }
  ]
}

🧩 Parse Markdown → AST → HTML

Pipeline:

Markdown
   ↓
AST (Remark)
   ↓
HTML (Rehype)

Suporte a:

• Frontmatter
• Slugs automáticos
• Autolink em headings
• Extensível via plugins

🔌 Expor hooks

O core expõe hooks para personalização:

• Manipulação de AST
• Transformação de HTML
• Interceptação de rotas
• Extensão de pipeline

Exemplo conceitual:

hubAtlas({
  hooks: {
    onParse(ast) {},
    onRoute(route) {},
    onBuild(tree) {}
  }
})

🏗 Arquitetura

O projeto é dividido em camadas:

core/
  loader
  router
  parser
  tree-builder
cli/
adapters/

Core

Responsável por toda lógica de documentação.

CLI

Interface para rodar via terminal.

Adapters (futuro)

Integração com:

• Next
• Fastify
• Vite
• Static build

🚀 Uso

npx hub-atlas ./docs

📦 Visão futura

• Sistema de plugins
• Busca integrada
• HMR em modo dev
• Adapters oficiais
• Geração estática
• Tema padrão opcional

🎯 Filosofia

HubAtlas não é um template. Não é um framework pesado.

É uma engine.

Você escolhe o servidor. Você escolhe o frontend. Você controla a arquitetura.

📜 Licença

MIT

src ├── fs/ → leitura de arquivos ├── graph/ → árvore de navegação ├── router/ → resolve URLs ├── parser/ → markdown → AST → HTML ├── hooks/ → lifecycle └── build/ → orquestra tudo