Об этом проекте

markdown-viewer (имя бинарного файла `mdv`) — это локальное средство просмотра Markdown и файловый браузер, распространяемое в виде одного бинарного файла. Он обслуживает каталог файлов Markdown по локальному HTTP-адресу и предоставляет двухпанельный интерфейс: раскрываемое постоянное дерево файлов слева и отрендеренное содержимое справа. Рендеринг охватывает GitHub Flavored Markdown со стилизацией, подобной GitHub, блоки кода с подсветкой синтаксиса и встроенную поддержку диаграмм Mermaid. Все ресурсы интерфейса — CSS, JavaScript и HTML-шаблоны — встроены в бинарный файл, поэтому внешние зависимости или отдельные шаги установки не требуются. Настройки безопасности по умолчанию включают защиту от обхода каталогов и санитизацию HTML против XSS. Завершение работы можно инициировать из интерфейса или с помощью Ctrl+C. Установка выполняется путём загрузки бинарного файла `mdv` для целевой платформы со страницы релизов, распаковки архива и размещения бинарного файла в PATH. Конфигурация может задаваться файлом `config.json` или флагами командной строки со следующим приоритетом (последующий переопределяет предыдущий): встроенные значения по умолчанию, `$HOME/.config/mdv/config.json`, `config.json` в текущем рабочем каталоге, переменные окружения с префиксом `MDV_` (например, `MDV_PORT=9000`) и, наконец, флаги командной строки. В качестве справочного материала предоставляется `config.json.example`. Использование: запустите `mdv` из любого каталога, содержащего файлы Markdown, и откройте `http://127.0.0.1:8080` в браузере. Флаги включают `-p, --port` (по умолчанию 8080), `-o, --open` для автоматического запуска браузера, `-d, --dir` для задания корневого каталога для обслуживания (по умолчанию `.`) и `--version`. Сборка из исходного кода требует Go 1.24 или более поздней версии. Цели Make включают `build` для текущей платформы, `build-all` для кросс-компиляции, `package` для создания zip-архивов, `test` и `clean`. Целевые платформы: linux/amd64, linux/arm64, darwin/arm64 и windows/amd64; сборки для macOS только arm64, тогда как Mac с Intel могут собирать из исходного кода. Репозиторий также включает CHANGELOG.md и NOTICE.md с указанием лицензий третьих сторон.