Repolode
Предложить
thiagokokada

thiagokokada/gh-gfm-preview

Go CLI и расширение GitHub CLI, запускающие локальный веб-сервер для предпросмотра GitHub Flavored Markdown, в том числе офлайн.

Open source альтернатива:GitHub Markdown preview

Открыть на GitHub
Звёзды
133
Форки
4
Открытые issues
0
Последний коммит
3 месяца назад

Что это?

gh-gfm-preview запускает локальный веб-сервер, который отображает Markdown-файл в браузере и старается максимально точно воспроизвести внешний вид Markdown на GitHub. Для рендеринга локально используются yuin/goldmark и его расширения, поэтому большинство возможностей работает без подключения к интернету.

Проект можно запускать как отдельный бинарный файл или как расширение GitHub CLI (`gh gfm-preview`). Он принимает путь к файлу, данные из стандартного ввода или автоматически находит README в текущей директории. При изменении файла поддерживается автоматическое обновление страницы. Режим просмотра директории позволяет просматривать и открывать несколько Markdown- и текстовых файлов.

Проект является форком gh-markdown-preview, который использует GitHub Markdown API и поэтому требует доступа к сети. Возможности, зависящие от доступа к GitHub, например упоминание пользователей или ссылки на issues, не поддерживаются.

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

  • 01Рендерит GFM с локальными расширениями goldmark и работает офлайн
  • 02Поддерживает диаграммы Mermaid, MathJax, alerts и блоки кода с подсветкой синтаксиса
  • 03Автоматически обновляет страницу в браузере при изменении файла
  • 04Принимает путь к файлу, данные из стандартного ввода или автоматически найденный README
  • 05Режим просмотра директории для просмотра нескольких файлов
  • 06Работает как отдельный бинарный файл или расширение GitHub CLI

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

  • Предпросмотр черновиков README или документации перед отправкой на GitHub
  • Предпросмотр Markdown из редактора, например Neovim, с помощью keymap
  • Работа с Markdown на компьютерах с ненадёжным доступом к интернету

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

  1. 1

    Установить как расширение GitHub CLI

    gh extension install thiagokokada/gh-gfm-preview
  2. 2

    Предварительно просмотреть файл Markdown в браузере

    gh gfm-preview README.md

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

  • Для диаграмм GeoJSON/TopoJSON и функций карты требуется подключение к интернету; 3D-диаграммы STL не поддерживаются.
  • Упоминания, ссылки на issues и pull requests, а также другие функции, зависящие от GitHub, недоступны.
  • Рендеринг эмулируется, поэтому он близок к результату GitHub, но не совпадает с ним полностью.

Темы

#markdown#cli#gfm#golang#offline#preview#gh-extension#go

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

Что такое gh-gfm-preview?
Go CLI и расширение GitHub CLI, запускающие локальный веб-сервер для предпросмотра GitHub Flavored Markdown, в том числе офлайн. gh-gfm-preview запускает локальный веб-сервер, который отображает Markdown-файл в браузере и старается максимально точно воспроизвести внешний вид Markdown на GitHub. Для рендеринга локально используются yuin/goldmark и его расширения, поэтому большинство возможностей работает без подключения к интернету.
gh-gfm-preview можно использовать бесплатно? Какая у него лицензия?
gh-gfm-preview распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.
gh-gfm-preview всё ещё поддерживается?
Обновлялся за последние 6 месяцев. Последний коммит в gh-gfm-preview — 24 июл. 2026 г..
Для чего можно использовать gh-gfm-preview?
Предпросмотр черновиков README или документации перед отправкой на GitHub Предпросмотр Markdown из редактора, например Neovim, с помощью keymap Работа с Markdown на компьютерах с ненадёжным доступом к интернету
Как установить gh-gfm-preview?
Установить как расширение GitHub CLI: gh extension install thiagokokada/gh-gfm-preview Предварительно просмотреть файл Markdown в браузере: gh gfm-preview README.md
Где скачать gh-gfm-preview?
Исходный код и инструкции по установке — на GitHub: https://github.com/thiagokokada/gh-gfm-preview

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

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