Czy istnieje narzędzie wiersza polecenia do renderowania Markdown o smaku GitHub?

Zastanawiam się, czy istnieje narzędzie wiersza polecenia do pobierania pliku Markdown o smaku GitHub i renderowania go w formacie HTML.

Używam wiki GitHub do tworzenia treści na stronie. Sklonowałem repozytorium na moim serwerze i chciałbym następnie przetworzyć je na zwykły kod HTML. Ważne jest dla mnie, że to, co pojawia się na GitHub, jest dokładnie tak, jak powinno wyglądać moja strona internetowa. Bardzo chciałbym również używać bloków ogrodzonych ~~~, więc wolałbym nie używać tylko standardowej składni Markdown.

Zajrzałem trochę do podglądu na żywo JavaScript, myśląc, że mógłbym podłączyć go do Node.js, ale mówią, że jest przestarzały. Przeglądałem repozytorium redcarpet, ale nie wygląda na to, żeby miało interfejs wiersza poleceń.

Rzuciłem jednak swoje własne rozwiązanie, ponieważ żadne rozwiązanie tutaj nie jest wyraźnie lepsze od innych, pozostawię pytanie bez wybranej odpowiedzi.

Napisałem mały CLI w Pythonie i dodałem obsługę GFM. Nazywa się Grip (Github Readme Instant Preview) .

Zainstaluj z:

$ pip install grip

Aby z niego skorzystać, po prostu:

$ grip

Następnie odwiedź, localhost:5000aby wyświetlić readme.mdplik w tej lokalizacji.

Możesz także określić własny plik:

$ grip CHANGES.md

I zmień port:

$ grip 8080

I, oczywiście, specjalnie renderuj Markdown o smaku GitHub, opcjonalnie z kontekstem repozytorium:

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

Ważne funkcje:

• Renderuje strony tak, aby wyglądały dokładnie tak, jak na GitHub
• Ogrodzone bloki
• Python API
• Nawiguj między połączonymi plikami (dzięki, vladwing !) Dodanymi w wersji 2.0
• Eksport do jednego pliku (dzięki, iliggio !) Dodanego w wersji 2.0
• Nowość: odczyt stdini eksport do stdout dodanego w 3.0

Mam nadzieję, że to pomoże komuś tutaj. Sprawdź to .

Nie znalazłem szybkiej i łatwej metody dla Markdown o smaku GitHub, ale znalazłem nieco bardziej ogólną wersję - Pandoc . Konwertuje z / do wielu formatów, w tym Markdown, Rest, HTML i innych.

Opracowałem również plik Makefiledo konwersji wszystkich plików .md do .html (w dużej części do przykładu w Writing, Markdown i 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 $@

Może to może pomóc:

gem install github-markdown

Nie istnieje żadna dokumentacja, ale mam ją z dokumentacji gollum . Patrząc na rubydoc.info , wygląda na to, że możesz użyć:

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

w twoim kodzie Ruby. Możesz to łatwo zawinąć w skrypt, aby zamienić go w narzędzie wiersza poleceń:

#!/usr/bin/env ruby

# render.rb
require 'github/markdown'

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

Wykonaj to za pomocą ./render.rb path/to/my/markdown/file.md. Należy pamiętać, że nie jest to bezpieczne do użycia w produkcji bez odkażania.

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

Nie obsługuje rozszerzeń GitHub, ale jest lepszy niż nic. Wierzę, że możesz rozszerzyć moduł, aby obsługiwał dodatki GitHub.

Prawdopodobnie nie to, czego chcesz, ale ponieważ wspomniałeś o Node.js: nie mogłem znaleźć dobrego narzędzia do podglądania dokumentacji GitHub Flavored Markdown na moim dysku lokalnym przed przekazaniem ich do GitHub, więc dzisiaj stworzyłem jedną, opartą na Node.js: https : //github.com/ypocat/gfms

Być może możesz użyć ponownie pliku showdown.js na swojej Wiki, jeśli twoje pytanie jest nadal aktualne. Jeśli nie, być może inne osoby, które borykają się z tym samym problemem, co ja, znajdą (tak jak ja) to pytanie i odpowiedź na nie.

Aby odczytać plik README.md w terminalu, którego używam:

pandoc README.md | lynx -stdin

Pandoc wysyła go w formacie HTML, który Lynx renderuje w twoim terminalu.

Działa świetnie: wypełnia mój terminal, skróty są pokazane poniżej, mogę przewijać, a linki działają! Jest tylko jeden rozmiar czcionki, ale rekompensują to kolory + wcięcie + wyrównanie.

Instalacja:

sudo apt-get install pandoc lynx

GitHub ma API Markdown, którego możesz użyć.

Użyj zaznaczonego . Obsługuje GitHub Flavored Markdown, może być używany jako moduł Node.js i z wiersza poleceń.

Przykładem może być:

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

Jest to głównie kontynuacja odpowiedzi @ barry-staes na użycie Pandoc . Homebrew ma to również, jeśli jesteś na komputerze Mac:

brew install pandoc

Pandoc obsługuje GFM jako format wejściowy poprzez markdown_githubnazwę.

Dane wyjściowe do pliku

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

Otwórz w Lynx

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

Otwórz w domyślnej przeglądarce w systemie OS X

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

Integracja TextMate

Zawsze możesz potokować bieżący wybór lub bieżący dokument do jednego z powyższych, jak pozwala na to większość edytorów. Możesz także łatwo skonfigurować środowisko, aby pandoczastępowało domyślny procesor Markdown używany przez pakiet Markdown .

Najpierw utwórz skrypt powłoki z następującą zawartością (zadzwonię ghmarkdown):

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

Następnie możesz ustawić TM_MARKDOWNzmienną (w Preferencjach → Zmienne) na /path/to/ghmarkdown, i zastąpi ona domyślny procesor Markdown.

Stworzyłem narzędzie podobne do funkcji podglądu Atom, ale jako samodzielna aplikacja. Nie jestem pewien, czy tego właśnie szukasz, ale może być pomocny. - https://github.com/yoshuawuyts/vmd

pandocz browserdziała dla mnie dobrze.

Stosowanie: cat README.md | pandoc -f markdown_github | browser

Instalacja (Zakładając, że używasz Mac OSX):

• $ brew install pandoc

• $ brew install browser

Lub na Debian / Ubuntu: apt-get install pandoc browser

Zobacz także https://softwareengineering.stackexchange.com/a/128721/24257 .

Jeśli interesuje Cię sposób, w jaki [Github] renderuje pliki Markdown, możesz wypróbować Redcarpet , nasz interfejs Ruby do biblioteki Sundown.

Skrypt Ruby, który korzysta z Redcarpet , będzie „narzędziem wiersza poleceń”, jeśli będziesz mieć lokalnego Ruby

Opierając się na tym komentarzu , napisałem jedno-linijkę, aby trafić do Github Markdown API przy użyciu curli jq.

Wklej tę funkcję bash do wiersza poleceń lub do ~/.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"
}

A następnie, aby zobaczyć renderowany HTML uruchomiony w przeglądarce:

mdsee readme.md

Wymień open "$HTMLFILE"się lynx "$HTMLFILE"jeśli potrzebujesz czystego roztworu terminala.

GitHub (od tego czasu) opracował ładny modułowy edytor tekstów o nazwie Atom (oparty na Chromium i używa modułów Node.js do pakietów).

Domyślnie preinstalowany pakiet Podgląd Markdown umożliwia wyświetlanie podglądu w osobnej zakładce za pomocą Ctrl+ Shift+ M.

Nie testowałem jej pełnej składni, ale ponieważ pochodzi ona z GitHub, byłbym bardzo zaskoczony, gdyby składnia podglądu była inna niż ich (blokowanie ogrodzeń przy użyciu ~~~pracy).

Teraz, chociaż technicznie nie jest oparty na wierszu poleceń, używa Node.js i wyświetla dane wyjściowe do renderera opartego na DOM , co może pomóc każdemu, kto próbuje renderować HTML oparty na składni GitHub na serwerze internetowym opartym na Node.js, lub po prostu edytować / jego plik README.md offline.

Moim ostatecznym rozwiązaniem było użycie Python Markdown . Zwinąłem własne przedłużenie, które naprawiło bloki ogrodzenia.

Istnieje naprawdę ładne i proste narzędzie do przeglądania dokumentów GFM Markdown:

GFMS - Github Flavored Markdown Server

Jest to prosty i lekki (nie wymaga konfiguracji) serwer HTTP, który możesz uruchomić w dowolnym katalogu zawierającym pliki Markdown, aby je przeglądać.

Funkcje:

• Pełna obsługa GFM Markdown
• Podświetlanie składni kodu źródłowego
• Przeglądanie plików i katalogów
• Ładnie wyglądający wynik (i konfigurowalne arkusze stylów CSS)
• Eksportuj do pliku PDF

W tym celu udało mi się użyć jednowierszowego skryptu Ruby (chociaż musiał on znajdować się w osobnym pliku). Najpierw uruchom te polecenia raz na każdym komputerze klienckim, z którego będziesz wypychać dokumenty:

gem install github-markup
gem install commonmarker

Następnie zainstaluj ten skrypt na obrazie klienta i nazwij go render-readme-for-javadoc.rb:

require 'github/markup'

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

Na koniec wywołaj to w ten sposób:

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

ETA: To nie pomoże ci w StackOverflow-flavour Markdown, który wydaje się zawodzić w tej odpowiedzi.

Używam Pandoc z opcją --from=gfmGitHub Flavored Markdown w następujący sposób:

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

Poprawa rozwiązania @ barry-stae. Wklej ten fragment w ~ / .bashrc

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

Następnie możemy szybko wyświetlić plik z wiersza poleceń. Działa również ładnie w sesjach SSH / Telnet.

mdviewer README.md

Późne dodawanie, ale showdownjs ma narzędzie CLI, którego możesz użyć do parsowania MD na HTML.

Znalazłem stronę internetową, która zrobi to za Ciebie: http://tmpvar.com/markdown.html . Wklej swoje Markdown, a wyświetli się dla ciebie. Wygląda na to, że działa dobrze!

Wydaje się jednak, że nie obsługuje opcji podświetlania składni kodu; oznacza to, że ~~~rubyfunkcja nie działa. Po prostu drukuje „rubin”.

Poprawiając odpowiedzi na @ barry-stae i @Sandeep dla zwykłych użytkowników elinks, dodałbyś następujące .bashrc:

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

Nie zapomnij zainstalować pandoc (i elinks).

Na podstawie odpowiedzi Jima Lima zainstalowałem klejnot GitHub Markdown. Obejmuje to skrypt o nazwie gfm, który pobiera nazwę pliku w wierszu poleceń i zapisuje równoważny kod HTML na standardowe wyjście. Zmodyfikowałem to nieco, aby zapisać plik na dysku, a następnie otworzyć standardową przeglądarkę z uruchomieniem:

#!/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)

Podejście „szybkie i brudne” polega na pobraniu stron HTML wiki za pomocą wgetnarzędzia, zamiast klonowania. Na przykład w ten sposób pobrałem wiki Hystrix z GitHub (używam 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

Pierwsze wywołanie spowoduje pobranie strony wejściowej wiki i wszystkich jej zależności. Drugi wywoła na nim wszystkie podstrony. Możesz teraz przeglądać wiki, otwierając Netflix/Hystrix/wiki.1.html.

Pamiętaj, że oba połączenia z wgetsą konieczne. Jeśli po prostu uruchomisz drugi, stracisz pewne zależności wymagane do prawidłowego wyświetlania stron.

Niedawno zrobiłem, co chcesz, ponieważ potrzebowałem wygenerować dokumentację z plików Markdown, a styl GitHub jest całkiem niezły. Spróbuj. Jest napisany w Node.js.

gfm