Gibt es ein Befehlszeilenprogramm zum Rendern von Markdown mit GitHub-Geschmack?

Ich frage mich, ob es ein Befehlszeilenprogramm gibt, mit dem eine Markdown- Datei mit GitHub-Geschmack in HTML gerendert werden kann.

Ich verwende ein GitHub-Wiki, um Website-Inhalte zu erstellen. Ich habe das Repository auf meinem Server geklont und möchte es dann zu normalem HTML verarbeiten. Es ist mir wichtig, dass auf GitHub genau so angezeigt wird, wie es für meine Website aussehen soll. Ich würde auch gerne die eingezäunten Blöcke mit verwenden ~~~, daher würde ich lieber nicht nur die Standard-Markdown-Syntax verwenden.

Ich habe ein bisschen in die JavaScript-Live-Vorschau geschaut und gedacht, ich könnte sie in Node.js einbinden, aber sie sagen, dass sie veraltet ist. Ich habe mir das Redcarpet-Repository angesehen, aber es sieht nicht so aus, als hätte es eine Befehlszeilenschnittstelle.

Ich habe jedoch meine eigene Lösung entwickelt, da hier keine Lösung eindeutig besser ist als die anderen, lasse ich die Frage ohne eine ausgewählte Antwort.

Ich habe eine kleine CLI in Python geschrieben und GFM-Unterstützung hinzugefügt. Es heißt Grip (Github Readme Instant Preview) .

Installieren Sie es mit:

$ pip install grip

Und um es zu benutzen, einfach:

$ grip

Besuchen Sie dann localhost:5000, um die readme.mdDatei an diesem Speicherort anzuzeigen .

Sie können auch Ihre eigene Datei angeben:

$ grip CHANGES.md

Und Port wechseln:

$ grip 8080

Und natürlich speziell GitHub-Flavored Markdown rendern, optional mit Repository-Kontext:

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

Bemerkenswerte Eigenschaften:

• Rendert Seiten so, dass sie genau wie auf GitHub aussehen
• Eingezäunte Blöcke
• Python-API
• Navigieren Sie zwischen verknüpften Dateien (danke, vladwing !) , Die in 2.0 hinzugefügt wurden
• Export in eine einzelne Datei (danke, iliggio !) In 2.0 hinzugefügt
• Neu: Aus 3.0 lesen stdinund exportierenstdout

Hoffe das hilft jemandem hier. Schau es dir an .

Ich habe keine schnelle und einfache Methode für Markdown mit GitHub-Geschmack gefunden, aber ich habe eine etwas allgemeinere Version gefunden - Pandoc . Es konvertiert von / in eine Reihe von Formaten, einschließlich Markdown, Rest, HTML und anderen.

Ich habe auch eine entwickelt Makefile, um alle .md-Dateien in .html zu konvertieren (größtenteils zum Beispiel bei Writing, Markdown und 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 $@

Vielleicht könnte das helfen:

gem install github-markdown

Es gibt keine Dokumentation, aber ich habe sie aus der Gollum- Dokumentation erhalten. Wenn Sie sich rubydoc.info ansehen , können Sie Folgendes verwenden:

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

in Ihrem Ruby-Code. Sie können dies einfach in ein Skript einbinden, um es in ein Befehlszeilenprogramm umzuwandeln:

#!/usr/bin/env ruby

# render.rb
require 'github/markdown'

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

Führen Sie es mit aus ./render.rb path/to/my/markdown/file.md. Beachten Sie, dass dies für die Verwendung in der Produktion ohne Desinfektion nicht sicher ist.

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

Es behandelt keine GitHub-Erweiterungen, ist aber besser als nichts. Ich glaube, Sie können das Modul erweitern, um die GitHub-Ergänzungen zu handhaben.

Wahrscheinlich nicht das, was Sie wollen, aber da Sie Node.js erwähnt haben: Ich konnte kein gutes Tool finden, um eine Vorschau der Dokumentation zu GitHub Flavored Markdown auf meinem lokalen Laufwerk anzuzeigen, bevor ich sie an GitHub festschrieb. Deshalb habe ich heute eines erstellt, das auf Node.js basiert: https : //github.com/ypocat/gfms

Vielleicht können Sie die showdown.js daraus für Ihr Wiki wiederverwenden, wenn Ihre Frage noch aktuell ist. Wenn nicht, werden vielleicht andere Leute, die mit dem gleichen Problem wie ich konfrontiert sind (genau wie ich), diese Frage und diese Antwort darauf finden.

Um eine README.md-Datei im Terminal zu lesen, verwende ich:

pandoc README.md | lynx -stdin

Pandoc gibt es im HTML-Format aus, das Lynx in Ihrem Terminal rendert.

Es funktioniert großartig: Es füllt mein Terminal, Verknüpfungen werden unten angezeigt, ich kann durchblättern und die Links funktionieren! Es gibt zwar nur eine Schriftgröße, aber die Farben + Einrückung + Ausrichtung machen das wieder wett.

Installation:

sudo apt-get install pandoc lynx

GitHub verfügt über eine Markdown-API, die Sie verwenden können.

Verwendung markiert . Es unterstützt GitHub Flavored Markdown, kann als Node.js-Modul und über die Befehlszeile verwendet werden.

Ein Beispiel wäre:

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

Dies ist hauptsächlich eine Fortsetzung der Antwort von @ barry-staes für die Verwendung von Pandoc . Homebrew hat es auch, wenn Sie auf einem Mac sind:

brew install pandoc

Pandoc unterstützt GFM als Eingabeformat über den markdown_githubNamen.

Ausgabe in Datei

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

In Lynx öffnen

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

Öffnen Sie im Standardbrowser unter OS X.

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

TextMate-Integration

Sie können die aktuelle Auswahl oder das aktuelle Dokument jederzeit an einen der oben genannten weiterleiten, wie dies bei den meisten Editoren möglich ist. Sie können die Umgebung auch einfach so konfigurieren, dass sie pandocden vom Markdown- Bundle verwendeten Standard-Markdown-Prozessor ersetzt .

Erstellen Sie zunächst ein Shell-Skript mit den folgenden Inhalten (ich werde es nennen ghmarkdown):

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

Sie können dann die TM_MARKDOWNVariable (unter Einstellungen → Variablen) auf /path/to/ghmarkdowneinstellen und sie ersetzt den Standard-Markdown-Prozessor.

Ich habe ein Tool erstellt, das der Vorschau-Funktion von Atom ähnelt, jedoch als eigenständige Anwendung. Ich bin mir nicht sicher, ob Sie danach suchen, aber es könnte hilfreich sein. - https://github.com/yoshuawuyts/vmd

pandocmit browserfunktioniert gut für mich.

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

Installation (Vorausgesetzt, Sie verwenden Mac OSX):

• $ brew install pandoc

• $ brew install browser

Oder auf Debian / Ubuntu: apt-get install pandoc browser

Siehe auch https://softwareengineering.stackexchange.com/a/128721/24257 .

Wenn Sie daran interessiert sind, wie wir [Github] Markdown-Dateien rendern, sollten Sie sich Redcarpet ansehen , unsere Ruby-Schnittstelle zur Sundown-Bibliothek.

Ruby-Skript, das Redcarpet verwendet , ist das "Befehlszeilenprogramm", wenn Sie über lokales Ruby verfügen

Aufbauend auf diesem Kommentar habe ich einen Einzeiler geschrieben, um die Github Markdown API mit curlund zu erreichen jq.

Fügen Sie diese Bash-Funktion in die Befehlszeile oder in Folgendes ein ~/.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"
}

Und dann, um zu sehen, wie das gerenderte HTML im Browser ausgeführt wird:

mdsee readme.md

Ersetzen Sie open "$HTMLFILE"durch, lynx "$HTMLFILE"wenn Sie eine reine Terminallösung benötigen.

GitHub hat (seitdem) einen schönen modularen Texteditor namens Atom entwickelt (basierend auf Chromium und verwendet Node.js- Module für Pakete).

Mit einer standardmäßigen vorinstallierten Paket- Markdown-Vorschau können Sie Ihre Vorschau mit Ctrl+ Shift+ auf einer separaten Registerkarte anzeigen M.

Ich habe die vollständige Syntax nicht getestet, aber da sie von GitHub stammt, wäre ich sehr überrascht, wenn sich die Syntax der Vorschau von ihrer unterscheidet (eingezäunte Blöcke mit ~~~Arbeit).

Obwohl es technisch nicht befehlszeilenbasiert ist, verwendet es Node.js und gibt es an einen DOM- basierten Renderer aus. Dies kann jedem helfen, der versucht, GitHub-Syntax-basiertes HTML auf einem Node.js-basierten Webserver zu rendern oder sie einfach zu bearbeiten / seine README.md offline.

Meine endgültige Lösung war die Verwendung von Python Markdown . Ich rollte meine eigene Verlängerung , die die Zaunblöcke reparierte.

Es gibt ein wirklich schönes und einfaches Tool zum Durchsuchen von GFM Markdown-Dokumenten:

GFMS - Markdown-Server mit Github-Geschmack

Es ist ein einfacher und leichter HTTP-Server (keine Konfiguration erforderlich), den Sie in jedem Verzeichnis mit Markdown-Dateien starten können, um sie zu durchsuchen.

Eigenschaften:

• Volle Unterstützung für GFM Markdown
• Hervorhebung der Quellcode-Syntax
• Durchsuchen von Dateien und Verzeichnissen
• Gut aussehende Ausgabe (und konfigurierbare CSS-Stylesheets)
• In PDF exportieren

Ich habe es geschafft, ein einzeiliges Ruby-Skript für diesen Zweck zu verwenden (obwohl es in einer separaten Datei gespeichert werden musste). Führen Sie diese Befehle zunächst einmal auf jedem Clientcomputer aus, von dem aus Sie Dokumente übertragen:

gem install github-markup
gem install commonmarker

Installieren Sie als Nächstes dieses Skript in Ihrem Client-Image und rufen Sie es auf render-readme-for-javadoc.rb:

require 'github/markup'

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

Rufen Sie es schließlich so auf:

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

ETA: Dies wird Ihnen bei StackOverflow-Markdown nicht helfen, was bei dieser Antwort anscheinend fehlschlägt.

Ich benutze Pandoc mit der Option --from=gfmfür GitHub Flavored Markdown wie folgt:

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

Verbesserung der Lösung von @ barry-stae. Stecke dieses Snippet in ~ / .bashrc

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

Dann können wir die Datei schnell über die Befehlszeile anzeigen. Funktioniert auch gut über SSH / Telnet-Sitzungen.

mdviewer README.md

Späte Hinzufügung, aber showdownjs verfügt über ein CLI-Tool, mit dem Sie MD in HTML analysieren können.

Ich habe eine Website gefunden, die dies für Sie erledigt : http://tmpvar.com/markdown.html . Fügen Sie Ihren Markdown ein und es wird für Sie angezeigt. Es scheint gut zu funktionieren!

Die Syntaxhervorhebungsoption für Code scheint jedoch nicht zu funktionieren. Das heißt, die ~~~rubyFunktion funktioniert nicht. Es wird nur "Rubin" gedruckt.

Wenn Sie die Antworten von @ barry-stae und @Sandeep für reguläre Benutzer von elinks verbessern, fügen Sie .bashrc Folgendes hinzu:

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

Vergessen Sie nicht, pandoc (und elinks) zu installieren.

Basierend auf Jim Lims Antwort habe ich das GitHub Markdown-Juwel installiert. Dazu gehörte ein Skript namens gfm, das einen Dateinamen in der Befehlszeile verwendet und den entsprechenden HTML-Code in die Standardausgabe schreibt. Ich habe das leicht geändert, um die Datei auf der Festplatte zu speichern und dann den Standardbrowser mit launchy zu öffnen:

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

Ein "schneller und schmutziger" Ansatz besteht darin, die Wiki-HTML-Seiten mit dem wgetDienstprogramm herunterzuladen , anstatt sie zu klonen. So habe ich beispielsweise das Hystrix-Wiki von GitHub heruntergeladen (ich verwende 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

Beim ersten Aufruf werden die Wiki-Einstiegsseite und alle ihre Abhängigkeiten heruntergeladen. Die zweite ruft alle Unterseiten auf. Sie können jetzt das Wiki durchsuchen, indem Sie es öffnen Netflix/Hystrix/wiki.1.html.

Beachten Sie, dass beide Aufrufe wgeterforderlich sind. Wenn Sie nur die zweite ausführen, werden Sie einige Abhängigkeiten übersehen, die erforderlich sind, um die Seiten richtig anzuzeigen.

Ich habe kürzlich gemacht, was Sie wollen, weil ich Dokumentation aus Markdown-Dateien generieren musste und der GitHub-Stil ziemlich gut ist. Versuch es. Es ist in Node.js geschrieben.

gfm