i3months/eziwiki

O que é?

Recursos principais

• 01Os arquivos em content/ são publicados automaticamente, e as pastas formam seções na barra lateral.
• 02A busca de texto completo é executada no navegador e indexa títulos e conteúdo das páginas.
• 03Os links de wiki são resolvidos pelo nome do arquivo, pelo título ou pelo caminho, e links quebrados são sinalizados.
• 04Backlinks e uma visualização do grafo do site mostram as relações entre as páginas.
• 05As páginas podem incorporar outras páginas ou seções, além de PDFs e imagens.
• 06Diagramas Mermaid, fórmulas matemáticas com KaTeX e blocos de código com realce de linhas são renderizados no momento do build.
• 07Tags, aliases para páginas movidas e datas da última atualização obtidas do histórico do git.

Casos de uso

• Publicar um jardim digital pessoal ou uma base de conhecimento a partir de notas em Markdown.
• Criar documentação interna para equipes, com links e busca.
• Criar uma wiki de projeto que possa ser publicada como arquivos estáticos.
• Manter um conjunto interligado de notas técnicas e verificar links quebrados no CI.

Início rápido

1. 1

   Criar um novo projeto

   npx create-eziwiki my-docs
2. 2

   Entrar na pasta do projeto

   cd my-docs
3. 3

   Instalar as dependências

   npm install
4. 4

   Iniciar o servidor de desenvolvimento e abrir http://localhost:3000

   npm run dev

Antes de usar

• !É necessário ter o Node.js 22.13 ou superior.
• !Antes da versão 1.0, as chaves de configuração, os campos de frontmatter ou as configurações podem mudar entre versões. Para atualizar, é preciso copiar manualmente os diretórios engine.

Em coleções

Tópicos

Perguntas frequentes

O que é eziwiki?

Uma wiki em Markdown e gerador de documentação baseado em Next.js, com busca, links de wiki, backlinks e visualização em grafo, com saída em arquivos estáticos. O EziWiki transforma uma pasta de arquivos Markdown em um site de wiki estático. Cada arquivo .md em content/ vira uma página publicada, e as pastas formam seções na barra lateral. Assim, não é necessário definir um array de navegação, a menos que você queira controlar manualmente os nomes e a ordem.

eziwiki é gratuito? Qual é a licença?

eziwiki é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.

eziwiki ainda é mantido?

Manutenção ativa. O último commit de eziwiki foi em 2 de nov. de 2026.

Para que posso usar eziwiki?

Publicar um jardim digital pessoal ou uma base de conhecimento a partir de notas em Markdown. Criar documentação interna para equipes, com links e busca. Criar uma wiki de projeto que possa ser publicada como arquivos estáticos. Manter um conjunto interligado de notas técnicas e verificar links quebrados no CI.

Como instalar eziwiki?

Criar um novo projeto: npx create-eziwiki my-docs Entrar na pasta do projeto: cd my-docs Instalar as dependências: npm install Iniciar o servidor de desenvolvimento e abrir http://localhost:3000: npm run dev

Onde consigo eziwiki?

O código-fonte e as instruções de instalação estão no GitHub: https://github.com/i3months/eziwiki