Repolode
i3months

i3months/eziwiki

Markdown-вики и генератор документации на Next.js с поиском, вики-ссылками, обратными ссылками и графом связей; результат — статические файлы.

Звёзды
112
Форки
14
Открытые issues
4
Последний коммит
5 дней назад

Что это?

EziWiki превращает папку с Markdown-файлами в статический сайт-вики. Каждый файл .md в content/ становится опубликованной страницей, а папки — разделами боковой панели. Поэтому массив навигации не нужен, если только вы не хотите вручную управлять названиями и порядком.

В проекте есть привычные для вики функции: полнотекстовый поиск в браузере, вики-ссылки вроде [[название страницы]], которые разрешаются во время сборки, включение других страниц или их разделов, обратные ссылки, теги и страница /graph, показывающая связи между страницами. Markdown, подсветка кода с помощью Shiki, формулы KaTeX и диаграммы Mermaid обрабатываются во время сборки, поэтому Markdown-парсер не загружается в браузер.

Результат — обычный статический HTML, который можно развернуть на Vercel, Netlify или GitHub Pages. В проект входит проверка ссылок: она сообщает о неработающих ссылках, страницах-сиротах и страницах, на которые ссылаются, но которые ещё не написаны.

Ключевые возможности

  • 01Файлы в content/ публикуются автоматически, а папки становятся разделами боковой панели.
  • 02Полнотекстовый поиск работает в браузере и индексирует заголовки и содержимое страниц.
  • 03Вики-ссылки разрешаются по имени файла, заголовку или пути, а неработающие ссылки отмечаются.
  • 04Обратные ссылки и общий граф сайта показывают связи между страницами.
  • 05В страницы можно включать другие страницы или их разделы, а также PDF-файлы и изображения.
  • 06Диаграммы Mermaid, формулы KaTeX и блоки кода с подсветкой строк обрабатываются во время сборки.
  • 07Теги, псевдонимы для перемещённых страниц и даты последнего обновления на основе истории git.

Сценарии использования

  • Публикация личного цифрового сада или базы знаний из Markdown-заметок.
  • Создание внутренней документации команды со ссылками и поиском.
  • Создание вики проекта, которую можно развернуть как статические файлы.
  • Ведение связанных технических заметок с проверкой неработающих ссылок в CI.

Быстрый старт

  1. 1

    Создать новый проект

    npx create-eziwiki my-docs
  2. 2

    Перейти в папку проекта

    cd my-docs
  3. 3

    Установить зависимости

    npm install
  4. 4

    Запустить сервер разработки и открыть http://localhost:3000

    npm run dev

Что важно знать

  • Требуется Node.js версии 22.13 или выше.
  • До версии 1.0 ключи конфигурации, поля frontmatter или настройки могут меняться от выпуска к выпуску. Для обновления необходимо вручную скопировать каталоги engine.

В подборках

Темы

Частые вопросы

Что такое eziwiki?
Markdown-вики и генератор документации на Next.js с поиском, вики-ссылками, обратными ссылками и графом связей; результат — статические файлы. EziWiki превращает папку с Markdown-файлами в статический сайт-вики. Каждый файл .md в content/ становится опубликованной страницей, а папки — разделами боковой панели. Поэтому массив навигации не нужен, если только вы не хотите вручную управлять названиями и порядком.
eziwiki можно использовать бесплатно? Какая у него лицензия?
eziwiki распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.
eziwiki всё ещё поддерживается?
Активно поддерживается. Последний коммит в eziwiki — 2 нояб. 2026 г..
Для чего можно использовать eziwiki?
Публикация личного цифрового сада или базы знаний из Markdown-заметок. Создание внутренней документации команды со ссылками и поиском. Создание вики проекта, которую можно развернуть как статические файлы. Ведение связанных технических заметок с проверкой неработающих ссылок в CI.
Как установить eziwiki?
Создать новый проект: npx create-eziwiki my-docs Перейти в папку проекта: cd my-docs Установить зависимости: npm install Запустить сервер разработки и открыть http://localhost:3000: npm run dev
Где скачать eziwiki?
Исходный код и инструкции по установке — на GitHub: https://github.com/i3months/eziwiki

Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.

Похожие проекты

Публикует папки с Markdown-файлами, заметки и документацию в виде сайтов за секунды: поддерживает перетаскивание файлов, Obsidian, GitHub и CLI для AI-агентов.

1,1 тыс.+2 за неделю120TypeScriptAGPL-3.0Активно поддерживаетсяОбновлён 4 дня назад

Открытая платформа для совместной работы с вики и документацией — альтернатива Confluence и Notion, которую можно развернуть на собственном сервере.

22,2 тыс.+79 за неделю1,7 тыс.TypeScriptAGPL-3.0Активно поддерживаетсяОбновлён 15 часов назад