MD Reader — это мощный и легкий инструмент для работы с Markdown-документацией. Он объединяет в себе скорость консольной утилиты и удобство современного графического интерфейса.
Проект идеально подходит для разработчиков, которые ведут базу знаний в .md файлах (например, Obsidian, Logseq или GitHub Wiki) и хотят иметь быстрый доступ к ней без тяжелых редакторов.
- Sidebar Navigation: Автоматическое дерево оглавления для всех файлов в папке.
- Живой поиск: Нечеткий поиск (Fuzzy Search) по заголовкам в реальном времени.
- Markdown Rendering: Красивое отображение текста с поддержкой форматирования.
- Портативность: Запуск в одно окно без лишних консолей.
- Interactive Mode: Поиск и чтение разделов прямо в терминале.
- TOC Generator: Вывод структуры любого Markdown файла.
- Statistics: Анализ объема документации (строки, файлы, заголовки).
Для сборки графической версии (Fyne) требуется C-компилятор (GCC/MinGW):
- Windows: w64devkit или MSYS2.
- WSL/Ubuntu:
sudo apt install libgl1-mesa-dev xorg-dev.
# Сборка GUI-версии (без консольного окна)
go build -ldflags="-H windowsgui" -o "MD Reader.exe" ./cmd/md-reader
# Сборка обычной CLI-версии
go build -o md-reader.exe ./cmd/md-reader| Папка | Описание |
|---|---|
cmd/ |
Точки входа в приложение |
internal/gui/ |
Логика Fyne интерфейса |
internal/viewer/ |
Ядро поиска и CLI-отображения |
internal/toc/ |
Парсер структуры Markdown |
internal/loader/ |
Безопасная загрузка файлов и кодировок |
Просто запустите файл или используйте команду:
.\md-reader.exe gui .open [path]— открыть файл/папку в терминале.toc [path]— показать оглавление.stats [path]— статистика по документации.
Приветствуются любые Pull Request! Особенно интересны:
- Поддержка Mermaid диаграмм.
- Темная/светлая темы для GUI.
- Экспорт в PDF/HTML.
Разработано с использованием Go и Fyne.