Apakah ada utilitas baris perintah untuk rendering GitHub Markdown rasa?

Saya bertanya-tanya apakah ada utilitas baris perintah untuk mengambil file Markdown beraroma GitHub dan merendernya ke HTML.

Saya menggunakan wiki GitHub untuk membuat konten situs web. Saya telah mengkloning repositori di server saya dan kemudian ingin memprosesnya menjadi HTML biasa. Penting bagi saya bahwa apa yang muncul di GitHub adalah bagaimana seharusnya mencari situs web saya. Saya juga sangat suka menggunakan blok berpagar ~~~, jadi saya lebih suka tidak menggunakan sintaks Markdown standar saja.

Saya telah melihat sedikit ke preview JavaScript hidup berpikir saya bisa menghubungkannya ke Node.js, tetapi mereka mengatakan itu sudah usang. Saya telah melihat repositori redcarpet, tetapi sepertinya tidak memiliki antarmuka baris perintah.

Saya menggulung solusi saya sendiri, karena tidak ada solusi di sini yang jelas lebih baik daripada yang lain, saya akan meninggalkan pertanyaan tanpa jawaban yang dipilih.

Saya menulis CLI kecil dengan Python dan menambahkan dukungan GFM. Ini disebut Grip (Github Readme Instant Preview) .

Instal dengan:

$ pip install grip

Dan untuk menggunakannya, cukup:

$ grip

Kemudian kunjungi localhost:5000untuk melihat readme.mdfile di lokasi itu.

Anda juga dapat menentukan file Anda sendiri:

$ grip CHANGES.md

Dan ganti port:

$ grip 8080

Dan tentu saja, secara khusus membuat GitHub-Flavoured Markdown, opsional dengan konteks repositori:

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

Fitur-fitur penting:

• Render halaman agar muncul persis seperti di GitHub
• Blok berpagar
• API Python
• Menavigasi antara file yang tertaut (terima kasih, vladwing !) Ditambahkan dalam 2.0
• Ekspor ke satu file (terima kasih, iliggio !) Ditambahkan dalam 2.0
• Baru: Baca dari stdindan ekspor untuk stdout ditambahkan dalam 3.0

Semoga ini bisa membantu seseorang di sini. Lihat itu .

Saya belum menemukan metode cepat dan mudah untuk Markdown rasa GitHub, tetapi saya telah menemukan versi yang sedikit lebih umum - Pandoc . Itu mengkonversi dari / ke sejumlah format, termasuk penurunan harga, istirahat, HTML dan lainnya.

Saya juga telah mengembangkan Makefileuntuk mengonversi semua file .md ke .html (sebagian besar pada contoh di Writing, Markdown, dan 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 $@

Mungkin ini bisa membantu:

gem install github-markdown

Tidak ada dokumentasi, tetapi saya mendapatkannya dari dokumentasi gollum . Melihat rubydoc.info , sepertinya Anda dapat menggunakan:

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

dalam kode Ruby Anda. Anda bisa membungkusnya dengan mudah dalam skrip untuk mengubahnya menjadi utilitas baris perintah:

#!/usr/bin/env ruby

# render.rb
require 'github/markdown'

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

Jalankan dengan ./render.rb path/to/my/markdown/file.md. Perhatikan bahwa ini tidak aman untuk digunakan dalam produksi tanpa sanitasi.

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

Itu tidak menangani ekstensi GitHub, tetapi lebih baik daripada tidak sama sekali. Saya percaya Anda dapat memperluas modul untuk menangani penambahan GitHub.

Mungkin bukan yang Anda inginkan, tetapi karena Anda menyebutkan Node.js: Saya tidak dapat menemukan alat yang bagus untuk melihat pratinjau dokumentasi GitHub Flavoured Markdown pada drive lokal saya sebelum memasukkannya ke GitHub, jadi hari ini saya membuat satu, berdasarkan Node.js: https : //github.com/ypocat/gfms

Jadi mungkin Anda dapat menggunakan kembali showdown.js dari itu untuk Wiki Anda, jika pertanyaan Anda masih aktual. Jika tidak, mungkin orang lain yang menghadapi masalah yang sama seperti saya akan menemukan (sama seperti saya) pertanyaan ini dan jawaban ini.

Untuk membaca file README.md di terminal yang saya gunakan:

pandoc README.md | lynx -stdin

Pandoc menampilkannya dalam format HTML, yang dirender oleh Lynx di terminal Anda.

Ini berfungsi dengan baik: Ini mengisi terminal saya, jalan pintas diperlihatkan di bawah, saya dapat menggulir, dan tautannya bekerja! Hanya ada satu ukuran font, tetapi warna + indentation + alignment membuat untuk itu.

Instalasi:

sudo apt-get install pandoc lynx

GitHub memiliki API Penurunan harga yang dapat Anda gunakan.

Gunakan yang ditandai . Ini mendukung GitHub Flavoured Markdown, dapat digunakan sebagai modul Node.js dan dari baris perintah.

Contohnya adalah:

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

Ini sebagian besar merupakan kelanjutan dari jawaban @ barry-staes untuk menggunakan Pandoc . Homebrew memilikinya juga, jika Anda menggunakan Mac:

brew install pandoc

Pandoc mendukung GFM sebagai format input melalui markdown_githubnama.

Output ke file

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

Buka di Lynx

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

Buka di browser default pada OS X

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

Integrasi TextMate

Anda selalu dapat menyalurkan seleksi saat ini atau dokumen saat ini ke salah satu di atas, karena sebagian besar editor memungkinkan Anda untuk melakukannya. Anda juga dapat dengan mudah mengkonfigurasi lingkungan sehingga pandocmenggantikan prosesor Markdown default yang digunakan oleh Markdown bundel .

Pertama, buat skrip shell dengan konten berikut (saya akan menyebutnya ghmarkdown):

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

Anda kemudian dapat mengatur TM_MARKDOWNvariabel (dalam Preferensi → Variabel) untuk /path/to/ghmarkdown, dan itu akan menggantikan prosesor penurunan harga default.

Saya membuat alat yang mirip dengan fungsi Pratinjau Atom, tetapi sebagai aplikasi mandiri. Tidak yakin apakah ini yang Anda cari, tetapi mungkin bermanfaat. - https://github.com/yoshuawuyts/vmd

pandocdengan browserbekerja dengan baik untukku.

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

Instalasi (Anggap Anda menggunakan Mac OSX):

• $ brew install pandoc

• $ brew install browser

Atau di Debian / Ubuntu: apt-get install pandoc browser

Lihat juga https://softwareengineering.stackexchange.com/a/128721/24257 .

Jika Anda tertarik dengan cara kami [Github] me-render file Markdown, Anda mungkin ingin memeriksa Redcarpet , antarmuka Ruby kami ke perpustakaan Sundown.

Script Ruby, yang menggunakan Redcarpet , akan menjadi "command line utility", jika Anda memiliki Ruby lokal

Membangun pada komentar ini saya menulis satu-liner untuk menekan Github Markdown API menggunakan curldan jq.

Rekatkan fungsi bash ini ke baris perintah atau ke ~/.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"
}

Dan kemudian untuk melihat HTML di-browser yang dijalankan berjalan:

mdsee readme.md

Ganti open "$HTMLFILE"dengan lynx "$HTMLFILE"jika Anda membutuhkan solusi terminal murni.

GitHub telah (sejak) mengembangkan editor teks modular yang bagus yang disebut Atom (berdasarkan Chromium dan menggunakan modul Node.js untuk paket).

Paket pra-instal bawaan Markdown Preview memungkinkan Anda menampilkan pratinjau di tab terpisah menggunakan Ctrl+ Shift+ M.

Saya belum menguji sintaks lengkapnya, tetapi karena itu berasal dari GitHub, saya akan sangat terkejut jika sintaks pratinjau berbeda dari mereka (blok berpagar menggunakan ~~~ pekerjaan).

Sekarang, meskipun secara teknis tidak berbasis command-line, ia menggunakan Node.js dan output ke renderer berbasis DOM , yang dapat membantu siapa pun yang mencoba merender GitHub berbasis sintaksis HTML pada server web berbasis Node.js, atau hanya mengeditnya / offline README.md-nya.

Solusi terakhir saya adalah menggunakan Python Markdown . Saya memutar ekstensi saya sendiri yang memperbaiki blok pagar.

Ada alat yang sangat bagus dan sederhana untuk menelusuri dokumen penurunan harga GFM:

GFMS - Github Flavoured Markdown Server

Ini sederhana dan ringan (tidak perlu konfigurasi) server HTTP yang dapat Anda mulai di direktori mana pun yang berisi file penurunan harga untuk menjelajahinya.

Fitur:

• Dukungan GFM Markdown penuh
• Menyoroti sintaksis kode sumber
• Menelusuri file dan direktori
• Output yang terlihat bagus (dan stylesheet CSS yang dapat dikonfigurasi)
• Ekspor ke PDF

Saya berhasil menggunakan skrip Ruby satu baris untuk tujuan itu (walaupun harus masuk dalam file terpisah). Pertama, jalankan perintah ini sekali pada setiap mesin klien Anda akan mendorong dokumen dari:

gem install github-markup
gem install commonmarker

Selanjutnya, instal skrip ini di gambar klien Anda, dan sebut saja render-readme-for-javadoc.rb:

require 'github/markup'

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

Akhirnya, aktifkan seperti ini:

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

ETA: Ini tidak akan membantu Anda dengan StackOverflow-flavor Markdown, yang tampaknya gagal pada jawaban ini.

Saya menggunakan Pandoc dengan opsi --from=gfmuntuk GitHub Flavoured Markdown seperti ini:

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

Memperbaiki solusi @ barry-stae. Tempelkan cuplikan ini di ~ / .bashrc

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

Kemudian kita dapat dengan cepat melihat file dari command-line. Juga bekerja dengan baik selama sesi SSH / Telnet.

mdviewer README.md

Penambahan terlambat tetapi showdownjs memiliki alat CLI yang dapat Anda gunakan untuk mem-parsing MD ke HTML.

Saya menemukan situs web yang akan melakukan ini untuk Anda: http://tmpvar.com/markdown.html . Tempel di Markdown Anda, dan itu akan menampilkannya untuk Anda. Tampaknya berfungsi dengan baik!

Namun, tampaknya tidak menangani opsi penyorotan sintaks untuk kode; artinya, ~~~rubyfitur tidak berfungsi. Itu hanya mencetak 'ruby'.

Meningkatkan pada @ barry-stae dan @Simpan jawaban untuk pengguna elinks biasa, Anda akan menambahkan yang berikut ini ke .bashrc:

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

Jangan lupa untuk menginstal pandoc (dan elinks).

Berdasarkan jawaban Jim Lim , saya memasang permata GitHub Markdown. Itu termasuk skrip bernama gfm yang mengambil nama file pada baris perintah dan menulis HTML yang setara ke output standar. Saya memodifikasi sedikit untuk menyimpan file ke disk dan kemudian untuk membuka browser standar dengan 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)

Pendekatan 'cepat dan kotor' adalah mengunduh halaman HTML wiki menggunakan wgetutilitas, alih-alih mengkloningnya. Sebagai contoh, ini adalah bagaimana saya mengunduh wiki Hystrix dari GitHub (Saya menggunakan 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

Panggilan pertama akan mengunduh halaman entri wiki dan semua dependensinya. Yang kedua akan memanggil semua sub-halaman di dalamnya. Anda dapat menelusuri sekarang wiki dengan membukaNetflix/Hystrix/wiki.1.html .

Perhatikan bahwa kedua panggilan wgetdiperlukan. Jika Anda hanya menjalankan yang kedua maka Anda akan kehilangan beberapa dependensi yang diperlukan untuk menampilkan halaman dengan benar.

Baru-baru ini saya membuat apa yang Anda inginkan, karena saya perlu membuat dokumentasi dari file Markdown dan gaya GitHub cukup bagus. Cobalah. Itu ditulis dalam Node.js.

gfm