Есть ли утилита командной строки для рендеринга GitHub со вкусом Markdown?

Мне интересно, есть ли утилита командной строки для получения файла Markdown со вкусом GitHub и рендеринга его в HTML.

Я использую вики GitHub для создания контента сайта. Я клонировал репозиторий на своем сервере и хотел бы обработать его в обычном HTML. Для меня важно, что то, что появляется на GitHub, именно так и должно выглядеть для моего сайта. Я также хотел бы использовать огороженные блоки с ~~~, поэтому я бы предпочел не использовать только стандартный синтаксис Markdown.

Я немного заглянул в предварительный просмотр JavaScript, думая, что смогу подключить его к Node.js, но они говорят, что он устарел. Я посмотрел на репозиторий redcarpet, но он не похож на интерфейс командной строки.

Я накатил свое собственное решение, однако, поскольку ни одно решение здесь явно не лучше, чем другие, я оставлю вопрос без выбранного ответа.

Я написал небольшой CLI на Python и добавил поддержку GFM. Это называется Grip (Github Readme Instant Preview) .

Установите его с помощью:

$ pip install grip

И использовать это просто:

$ grip

Тогда посетите localhost:5000 чтобы просмотреть readme.mdфайл в этом месте.

Вы также можете указать свой собственный файл:

$ grip CHANGES.md

И изменить порт:

$ grip 8080

И, конечно же, специально отображать GitHub-Flavored Markdown, опционально с контекстом репозитория:

$ grip --gfm --context=username/repo issue.md

Известные особенности:

• Отображает страницы так же, как на GitHub
• Огороженные блоки
• Python API
• Навигация между связанными файлами (спасибо, vladwing !) Добавлена ​​в 2.0
• Экспорт в один файл (спасибо, iliggio !) Добавлен в 2.0
• Новое: чтение stdinи stdout добавление в 3.0.

Надеюсь, это поможет кому-то здесь. Проверьте это .

Я не нашел быстрого и простого метода для Markdown со вкусом GitHub, но нашел немного более общую версию - Pandoc . Он конвертирует из / в ряд форматов, включая Markdown, Rest, HTML и другие.

Я также разработал Makefileдля преобразования всех файлов .md в .html (в значительной степени к примеру в Writing, Markdown и Pandoc ):

# 'Makefile'
MARKDOWN = pandoc --from gfm --to html --standalone
all: $(patsubst %.md,%.html,$(wildcard *.md)) Makefile

clean:
    rm -f $(patsubst %.md,%.html,$(wildcard *.md))
    rm -f *.bak *~

%.html: %.md
    $(MARKDOWN) $< --output $@

Может быть, это может помочь:

gem install github-markdown

Документации не существует, но я получил ее из документации gollum . Глядя на rubydoc.info , похоже, что вы можете использовать:

require 'github/markdown'  
puts GitHub::Markdown.render_gfm('your markdown string')

в вашем коде Ruby. Вы можете легко обернуть это в скрипт, чтобы превратить его в утилиту командной строки:

#!/usr/bin/env ruby

# render.rb
require 'github/markdown'

puts GitHub::Markdown.render_gfm File.read(ARGV[0])

Выполните это с ./render.rb path/to/my/markdown/file.md. Обратите внимание, что это небезопасно для использования в производстве без очистки.

pip3 install --user markdown
python3 -m markdown readme.md > readme.html

Он не обрабатывает расширения GitHub, но это лучше, чем ничего. Я считаю, что вы можете расширить модуль для обработки дополнений GitHub.

Возможно, это не то, что вам нужно, но, поскольку вы упомянули Node.js: я не смог найти хороший инструмент для предварительного просмотра документации GitHub Flavored Markdown на моем локальном диске перед их фиксацией в GitHub, поэтому сегодня я создал один на основе Node.js: https : //github.com/ypocat/gfms

Так что, возможно, вы можете использовать showdown.js из него для своей Wiki, если ваш вопрос все еще актуален. Если нет, возможно, другие люди, столкнувшиеся с той же проблемой, что и я, найдут (как и я) этот вопрос и ответ на него.

Для чтения файла README.md в терминале я использую:

pandoc README.md | lynx -stdin

Pandoc выводит его в формате HTML, который Lynx отображает в вашем терминале.

Он отлично работает: он заполняет мой терминал, ярлыки показаны ниже, я могу пролистать, и ссылки работают! Хотя есть только один размер шрифта, но цвета + отступы + выравнивание восполняют это.

Установка:

sudo apt-get install pandoc lynx

GitHub имеет API Markdown, который вы можете использовать.

Используйте помеченные . Он поддерживает GitHub Flavored Markdown, может использоваться как модуль Node.js и из командной строки.

Примером может быть:

$ marked -o hello.html
hello world
^D
$ cat hello.html
<p>hello world</p>

В основном это продолжение ответа @ barry-staes за использование Pandoc . У Homebrew это также есть, если вы на Mac:

brew install pandoc

Pandoc поддерживает GFM в качестве формата ввода через markdown_githubимя.

Вывод в файл

cat foo.md | pandoc -f markdown_github > foo.html

Открыть в рыси

cat foo.md | pandoc -f markdown_github | lynx -stdin # To open in Lynx

Откройте в браузере по умолчанию на OS X

cat foo.md | pandoc -f markdown_github > foo.html && open foo.html # To open in the default browser on OS X`

Интеграция TextMate

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

Сначала создайте скрипт оболочки со следующим содержимым (я его назову ghmarkdown):

#!/bin/bash
# Note included, optional --email-obfuscation arg
pandoc -f markdown_github --email-obfuscation=references

Затем вы можете установить TM_MARKDOWNпеременную (в Предпочтения → Переменные) /path/to/ghmarkdown, и она заменит процессор Markdown по умолчанию.

Я создал инструмент, аналогичный функциональности предварительного просмотра Atom, но как отдельное приложение. Не уверен, что это то, что вы ищете, но это может быть полезно. - https://github.com/yoshuawuyts/vmd

pandocс browserхорошо работает для меня.

Применение: cat README.md | pandoc -f markdown_github | browser

Установка (при условии, что вы используете Mac OSX):

• $ brew install pandoc

• $ brew install browser

Или на Debian / Ubuntu: apt-get install pandoc browser

Также см. Https://softwareengineering.stackexchange.com/a/128721/24257 .

Если вы заинтересованы в том, как мы [Github] визуализируем файлы Markdown, вы можете попробовать Redcarpet , наш интерфейс Ruby для библиотеки Sundown.

Ruby-скрипт, использующий Redcarpet , будет «утилитой командной строки», если у вас будет локальный Ruby

Основываясь на этом комментарии, я написал однострочник, чтобы поразить Github Markdown API, используя curlи jq.

Вставьте эту функцию bash в командную строку или в ваш ~/.bash_profile:

mdsee(){ 
    HTMLFILE="$(mktemp -u).html"
    cat "$1" | \
      jq --slurp --raw-input '{"text": "\(.)", "mode": "markdown"}' | \
      curl -s --data @- https://api.github.com/markdown > "$HTMLFILE"
    echo $HTMLFILE
    open "$HTMLFILE"
}

А затем, чтобы увидеть, как отображается обработанный HTML-код в браузере:

mdsee readme.md

Замените open "$HTMLFILE"на, lynx "$HTMLFILE"если вам нужно чистое терминальное решение.

GitHub (с тех пор) разработал хороший модульный текстовый редактор под названием Atom (на основе Chromium и использует Node.js). модули для пакетов).

Предварительно установленный по умолчанию пакет Markdown Preview позволяет отображать предварительный просмотр на отдельной вкладке с помощью Ctrl+ Shift+ M.

Я не проверял его полный синтаксис, но, поскольку он исходит от GitHub, я был бы очень удивлен, если бы синтаксис предварительного просмотра отличался от их (огражденные блоки используют ~~~work).

Теперь, хотя технически он не основан на командной строке, он использует Node.js и выводит его на DOM- рендерер, который может помочь любому, пытающемуся отобразить HTML на основе синтаксиса GitHub на веб-сервере на основе Node.js, или просто отредактировать ее. / его README.md не в сети.

Мое окончательное решение было использовать Python Markdown . Я свернул свое собственное расширение, которое установило блоки забора.

Существует действительно хороший и простой инструмент для просмотра документов GFM Markdown:

GFMS - Github ароматизированный сервер уценки

Это простой и легкий (не требующий настройки) HTTP-сервер, который вы можете запустить в любом каталоге, содержащем файлы уценки, чтобы просмотреть их.

Особенности:

• Полная поддержка GFM Markdown
• Подсветка синтаксиса исходного кода
• Просмотр файлов и каталогов
• Приятный внешний вид (и настраиваемые таблицы стилей CSS)
• Экспорт в PDF

Мне удалось использовать для этой цели однострочный скрипт Ruby (хотя он должен был находиться в отдельном файле). Сначала выполните эти команды один раз на каждой клиентской машине, с которой вы будете загружать документы:

gem install github-markup
gem install commonmarker

Затем установите этот скрипт в образе клиента и назовите его render-readme-for-javadoc.rb:

require 'github/markup'

puts GitHub::Markup.render_s(GitHub::Markups::MARKUP_MARKDOWN, File.read('README.md'))

Наконец, вызовите это так:

ruby ./render-readme-for-javadoc.rb >> project/src/main/javadoc/overview.html

ETA: Это не поможет вам с Markdown StackOverflow-flavour, который, похоже, не отвечает этому ответу.

Я использую Pandoc с опцией --from=gfmдля GitHub Flavored Markdown следующим образом:

$ pandoc my_file.md   --from=gfm -t html -o my_file.html

Улучшение решения @ barry-stae. Вставьте этот фрагмент в ~ / .bashrc

function mdviewer(){
  pandoc $* | lynx -stdin
}

Затем мы можем быстро просмотреть файл из командной строки. Также хорошо работает в сеансах SSH / Telnet.

mdviewer README.md

Позднее добавление, но у showdownjs есть инструмент CLI, который вы можете использовать для анализа MD в HTML.

Я нашел сайт, который сделает это за вас: http://tmpvar.com/markdown.html . Вставьте свой Markdown, и он отобразит его для вас. Кажется, работает просто отлично!

Тем не менее, он, кажется, не обрабатывает опцию подсветки синтаксиса для кода; то есть ~~~rubyфункция не работает. Это просто печатает «рубин».

Улучшая ответы @ barry-stae и @Sandeep для обычных пользователей elinks, вы добавили бы следующее .bashrc:

function mdviewer() {
  pandoc $* | elinks --force-html
}

Не забудьте установить pandoc (и elinks).

Основываясь на ответе Джима Лима , я установил гем GitHub Markdown. Это включало скрипт gfm, который принимает имя файла в командной строке и записывает эквивалентный HTML в стандартный вывод. Я немного изменил это, чтобы сохранить файл на диск, а затем открыть стандартный браузер с помощью launchy:

#!/usr/bin/env ruby

HELP = <<-help
  Usage: gfm [--readme | --plaintext] [<file>]
  Convert a GitHub-Flavored Markdown file to HTML and write to standard output.
  With no <file> or when <file> is '-', read Markdown source text from standard input.
  With `--readme`, the files are parsed like README.md files in GitHub.com. By default,
  the files are parsed with all the GFM extensions.
help

if ARGV.include?('--help')
  puts HELP
  exit 0
end

root = File.expand_path('../../', __FILE__)
$:.unshift File.expand_path('lib', root)

require 'github/markdown'
require 'tempfile'
require 'launchy'

mode = :gfm
mode = :markdown if ARGV.delete('--readme')
mode = :plaintext if ARGV.delete('--plaintext')

outputFilePath = File.join(Dir.tmpdir, File.basename(ARGF.path))  + ".html"

File.open(outputFilePath, "w") do |outputFile |
    outputFile.write(GitHub::Markdown.to_html(ARGF.read, mode))
end

outputFileUri = 'file:///' + outputFilePath

Launchy.open(outputFileUri)

Подход «быстрый и грязный» заключается в загрузке HTML-страниц вики с помощью wgetутилиты, а не клонировании. Например, вот как я скачал вики Hystrix с GitHub (я использую Ubuntu Linux):

 $ wget -e robots=off -nH -E -H -k -K -p https://github.com/Netflix/Hystrix/wiki
 $ wget -e robots=off -nH -E -H -k -K -I "Netflix/Hystrix/wiki" -r -l 1 https://github.com/Netflix/Hystrix/wiki

Первый вызов загрузит страницу входа в вики и все ее зависимости. Второй вызовет все подстраницы на нем. Теперь вы можете просматривать вики, открывNetflix/Hystrix/wiki.1.html .

Обратите внимание, что оба вызова wgetнеобходимы. Если вы просто запустите второй, то пропустите некоторые зависимости, необходимые для правильного отображения страниц.

Я недавно сделал то, что вы хотите, потому что мне нужно было сгенерировать документацию из файлов Markdown, и стиль GitHub довольно хорош. Попробуй это. Написано в Node.js.

GFM