Esiste un'utilità da riga di comando per il rendering di Markdown aromatizzato GitHub?

Mi chiedo se esiste un'utilità da riga di comando per prendere un file Markdown aromatizzato GitHub e renderlo in HTML.

Sto usando un wiki GitHub per creare contenuti per siti Web. Ho clonato il repository sul mio server e vorrei quindi elaborarlo in HTML normale. Per me è importante che ciò che appare su GitHub sia esattamente come dovrebbe cercare il mio sito web. Mi piacerebbe anche usare i blocchi recintati ~~~, quindi preferirei non usare solo la sintassi Markdown standard.

Ho esaminato un po 'l'anteprima live di JavaScript pensando di poterlo collegare a Node.js, ma dicono che è deprecato. Ho esaminato il repository redcarpet, ma non sembra che abbia un'interfaccia a riga di comando.

Ho lanciato la mia soluzione, tuttavia, poiché nessuna soluzione qui è chiaramente migliore delle altre, lascerò la domanda senza una risposta selezionata.

Ho scritto una piccola CLI in Python e aggiunto il supporto GFM. Si chiama Grip (Github Readme Instant Preview) .

Installalo con:

$ pip install grip

E per usarlo, semplicemente:

$ grip

Quindi visita localhost:5000per visualizzare il readme.mdfile in quella posizione.

Puoi anche specificare il tuo file:

$ grip CHANGES.md

E cambia porta:

$ grip 8080

E, naturalmente, rende specificamente Markdown al gusto di GitHub, facoltativamente con il contesto del repository:

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

Caratteristiche notevoli:

• Esegue il rendering delle pagine esattamente come su GitHub
• Blocchi recintati
• API Python
• Naviga tra i file collegati (grazie, vladwing !) Aggiunti in 2.0
• Esporta in un singolo file (grazie, iliggio !) Aggiunto in 2.0
• Novità: leggi stdined esporta in stdout aggiunto in 3.0

Spero che questo aiuti qualcuno qui. Dai un'occhiata .

Non ho trovato un metodo rapido e semplice per Markdown al gusto di GitHub, ma ho trovato una versione leggermente più generica: Pandoc . Converte da / in un numero di formati, tra cui Markdown, Rest, HTML e altri.

Ho anche sviluppato un Makefileper convertire tutti i file .md in .html (in gran parte nell'esempio in Writing, Markdown e 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 $@

Forse questo potrebbe aiutare:

gem install github-markdown

Non esiste documentazione, ma l'ho preso dalla documentazione di Gollum . Guardando rubydoc.info , sembra che tu possa usare:

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

nel tuo codice Ruby. Puoi avvolgerlo facilmente in uno script per trasformarlo in un'utilità della riga di comando:

#!/usr/bin/env ruby

# render.rb
require 'github/markdown'

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

Eseguilo con ./render.rb path/to/my/markdown/file.md. Si noti che questo non è sicuro per l'uso in produzione senza sanificazione.

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

Non gestisce le estensioni GitHub, ma è meglio di niente. Credo che tu possa estendere il modulo per gestire le aggiunte di GitHub.

Probabilmente non quello che vuoi, ma da quando hai menzionato Node.js: non sono riuscito a trovare un buon strumento per visualizzare in anteprima la documentazione Markdown aromatizzato GitHub sul mio disco locale prima di inviarli a GitHub, quindi oggi ne ho creato uno, basato su Node.js: https : //github.com/ypocat/gfms

Quindi forse puoi riutilizzare showdown.js da esso per il tuo Wiki, se la tua domanda è ancora effettiva. In caso contrario, forse altre persone che affrontano lo stesso problema che ho riscontrato troveranno (proprio come ho fatto io) questa domanda e questa risposta.

Per leggere un file README.md nel terminale che uso:

pandoc README.md | lynx -stdin

Pandoc lo emette in formato HTML, che Lynx rende nel tuo terminale.

Funziona benissimo: riempie il mio terminale, le scorciatoie sono mostrate di seguito, posso scorrere e i collegamenti funzionano! Tuttavia, esiste solo una dimensione del carattere, ma i colori + rientro + allineamento lo compensano.

Installazione:

sudo apt-get install pandoc lynx

GitHub ha un'API Markdown che puoi usare.

Usa contrassegnato . Supporta GitHub Flavored Markdown, può essere usato come modulo Node.js e dalla riga di comando.

Un esempio potrebbe essere:

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

Questo è principalmente un seguito alla risposta di @ barry-staes per l'utilizzo di Pandoc . Anche Homebrew ce l'ha, se sei su un Mac:

brew install pandoc

Pandoc supporta GFM come formato di input tramite il markdown_githubnome.

Uscita su file

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

Apri in Lynx

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

Apri nel browser predefinito su OS X

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

Integrazione TextMate

Puoi sempre reindirizzare la selezione corrente o il documento corrente a uno dei precedenti, come la maggior parte degli editor ti consente di fare. È inoltre possibile configurare facilmente l'ambiente in modo che pandocsostituisca il processore Markdown predefinito utilizzato dal pacchetto Markdown .

Innanzitutto, crea uno script di shell con i seguenti contenuti (lo chiamerò ghmarkdown):

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

È quindi possibile impostare la TM_MARKDOWNvariabile (in Preferenze → Variabili) su /path/to/ghmarkdowne sostituirà il processore Markdown predefinito.

Ho creato uno strumento simile alla funzionalità Anteprima di Atom, ma come applicazione autonoma. Non sono sicuro se questo è quello che stai cercando, ma potrebbe essere utile. - https://github.com/yoshuawuyts/vmd

pandoccon browserfunziona bene per me.

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

Installazione (Supponendo che tu stia utilizzando Mac OSX):

• $ brew install pandoc

• $ brew install browser

O su Debian / Ubuntu: apt-get install pandoc browser

Vedi anche https://softwareengineering.stackexchange.com/a/128721/24257 .

Se sei interessato al modo in cui [Github] esegue il rendering dei file Markdown, potresti provare Redcarpet , la nostra interfaccia Ruby per la libreria Sundown.

Ruby-script, che utilizza Redcarpet , sarà "utility da riga di comando", se avrai Ruby locale

Sulla base di questo commento, ho scritto una riga per colpire l' API Github Markdown usando curle jq.

Incolla questa funzione bash nella riga di comando o nel tuo ~/.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"
}

E quindi per visualizzare l'esecuzione HTML nel browser renderizzata:

mdsee readme.md

Sostituire open "$HTMLFILE"con lynx "$HTMLFILE"se è necessaria una soluzione terminale pura.

GitHub ha (da allora) sviluppato un piacevole editor di testo modulare chiamato Atom (basato su Chromium e utilizza Node.js moduli per i pacchetti).

Un pacchetto preinstallato predefinito Anteprima del menu a discesa consente di visualizzare l'anteprima in una scheda separata utilizzando Ctrl+ Shift+M .

Non ho testato la sua sintassi completa, ma poiché proviene da GitHub, sarei molto sorpreso se la sintassi dell'anteprima fosse diversa dalla loro (blocchi recintati che utilizzano ~~~ lavoro).

Ora, sebbene non sia tecnicamente basato sulla riga di comando, utilizza Node.js e restituisce un renderer basato su DOM , il che potrebbe aiutare chiunque cerchi di eseguire il rendering di HTML basato sulla sintassi GitHub su un server web basato su Node.js o semplicemente modificarla / suo README.md offline.

La mia soluzione finale era usare Python Markdown . Ho rotolato la mia estensione che ha riparato i blocchi di recinzione.

Esiste uno strumento davvero piacevole e semplice per sfogliare i documenti Markdown di GFM:

GFMS - Server di markdown aromatizzato Github

È un server HTTP semplice e leggero (nessuna configurazione necessaria) che puoi avviare in qualsiasi directory contenente file markdown per sfogliarli.

Caratteristiche:

• Pieno supporto Markdown GFM
• Evidenziazione della sintassi del codice sorgente
• Navigazione di file e directory
• Output piacevole (e fogli di stile CSS configurabili)
• Esporta in PDF

Sono riuscito a utilizzare uno script Ruby di una riga per quello scopo (anche se doveva andare in un file separato). Innanzitutto, esegui questi comandi una volta su ogni macchina client da cui invierai documenti da:

gem install github-markup
gem install commonmarker

Quindi, installa questo script nell'immagine client e chiamalo render-readme-for-javadoc.rb:

require 'github/markup'

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

Infine, invocalo in questo modo:

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

ETA: Questo non ti aiuterà con StackOverflow-sapore Markdown, che sembra fallire in questa risposta.

Uso Pandoc con l'opzione --from=gfmper GitHub Flavored Markdown in questo modo:

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

Miglioramento della soluzione di @ barry-stae. Inserisci questo snippet in ~ / .bashrc

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

Quindi possiamo visualizzare rapidamente il file dalla riga di comando. Funziona bene anche su sessioni SSH / Telnet.

mdviewer README.md

Aggiunta tardiva ma showdownjs ha uno strumento CLI che puoi usare per analizzare MD in HTML.

Ho trovato un sito Web che lo farà per te: http://tmpvar.com/markdown.html . Incolla il tuo Markdown e lo mostrerà per te. Sembra funzionare bene!

Tuttavia, non sembra gestire l'opzione di evidenziazione della sintassi per il codice; cioè, la ~~~rubyfunzione non funziona. Stampa solo 'rubino'.

Migliorando le risposte di @ barry-stae e @Sandeep per gli utenti regolari di elink, aggiungerebbe a .bashrc:

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

Non dimenticare di installare pandoc (ed elinks).

Sulla base della risposta di Jim Lim , ho installato la gemma GitHub Markdown. Ciò includeva uno script chiamato gfm che accetta un nome file dalla riga di comando e scrive l'HTML equivalente nell'output standard. L'ho modificato leggermente per salvare il file su disco e quindi per aprire il browser standard con 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)

Un approccio 'rapido e sporco' è quello di scaricare le pagine HTML della wiki usando l' wgetutilità, invece di clonarla. Ad esempio, è così che ho scaricato il wiki di Hystrix da GitHub (sto usando 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

La prima chiamata scaricherà la pagina di entrata della wiki e tutte le sue dipendenze. Il secondo chiamerà tutte le sottopagine su di esso. Puoi sfogliare ora il wiki aprendoNetflix/Hystrix/wiki.1.html .

Si noti che entrambe le chiamate wgetsono necessarie. Se esegui solo la seconda, perderai alcune dipendenze necessarie per mostrare correttamente le pagine.

Di recente ho realizzato quello che volevi, perché avevo bisogno di generare documentazione dai file Markdown e lo stile GitHub è piuttosto carino. Provalo. È scritto in Node.js.

GFM