Có tiện ích dòng lệnh nào để hiển thị Markdown có hương vị GitHub không?

Tôi tự hỏi nếu có một tiện ích dòng lệnh để lấy tệp Markdown có hương vị GitHub và hiển thị nó thành HTML.

Tôi đang sử dụng wiki GitHub để tạo nội dung trang web. Tôi đã nhân bản kho lưu trữ trên máy chủ của mình và sau đó muốn xử lý nó thành HTML thông thường. Điều quan trọng với tôi là những gì xuất hiện trên GitHub chính xác là cách nó sẽ tìm trang web của tôi. Tôi cũng thực sự muốn sử dụng các khối có rào chắn ~~~, vì vậy tôi không chỉ sử dụng cú pháp Markdown tiêu chuẩn.

Tôi đã xem xét một chút về bản xem trước trực tiếp JavaScript với suy nghĩ rằng tôi có thể nối nó vào Node.js, nhưng họ nói rằng nó không được dùng nữa. Tôi đã xem kho lưu trữ redcarpet, nhưng có vẻ như nó không có giao diện dòng lệnh.

Tôi đã đưa ra giải pháp của riêng mình, tuy nhiên, vì không có giải pháp nào ở đây rõ ràng tốt hơn các giải pháp khác, tôi sẽ để lại câu hỏi mà không có câu trả lời được chọn.

Tôi đã viết một CLI nhỏ bằng Python và thêm hỗ trợ GFM. Nó được gọi là Grip (Github Readme Instant Preview) .

Cài đặt nó với:

$ pip install grip

Và để sử dụng nó, chỉ cần:

$ grip

Sau đó truy cập localhost:5000để xem các readme.mdtập tin tại vị trí đó.

Bạn cũng có thể chỉ định tệp của riêng bạn:

$ grip CHANGES.md

Và đổi cổng:

$ grip 8080

Và tất nhiên, đặc biệt hiển thị GitHub-Flavored Markdown, tùy chọn với bối cảnh kho lưu trữ:

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

Các tính năng đáng chú ý:

• Các trang của Render xuất hiện chính xác như trên GitHub
• Khối có rào chắn
• API Python
• Điều hướng giữa các tệp được liên kết (cảm ơn, vladwing !) Được thêm vào 2.0
• Xuất thành một tệp duy nhất (cảm ơn, iliggio !) Được thêm vào 2.0
• Mới: Đọc từ stdinvà xuất để stdout thêm vào 3.0

Hy vọng điều này sẽ giúp ai đó ở đây. Kiểm tra nó ra .

Tôi chưa tìm thấy một phương pháp nhanh chóng và dễ dàng cho Markdown có hương vị GitHub, nhưng tôi đã tìm thấy một phiên bản chung chung hơn một chút - Pandoc . Nó chuyển đổi từ / sang một số định dạng, bao gồm Markdown, Rest, HTML và các định dạng khác.

Tôi cũng đã phát triển một Makefileđể chuyển đổi tất cả các tệp .md thành .html (phần lớn thành ví dụ tại Writing, Markdown và 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 $@

Có lẽ điều này có thể giúp:

gem install github-markdown

Không có tài liệu nào tồn tại, nhưng tôi đã nhận được nó từ tài liệu gollum . Nhìn vào rubydoc.info , có vẻ như bạn có thể sử dụng:

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

trong mã Ruby của bạn. Bạn có thể gói nó dễ dàng trong một tập lệnh để biến nó thành một tiện ích dòng lệnh:

#!/usr/bin/env ruby

# render.rb
require 'github/markdown'

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

Thực hiện nó với ./render.rb path/to/my/markdown/file.md. Lưu ý rằng điều này không an toàn để sử dụng trong sản xuất mà không khử trùng.

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

Nó không xử lý các phần mở rộng GitHub, nhưng tốt hơn là không có gì. Tôi tin rằng bạn có thể mở rộng mô-đun để xử lý các bổ sung GitHub.

Có thể không phải là những gì bạn muốn, nhưng vì bạn đã đề cập đến Node.js: Tôi không thể tìm thấy một công cụ tốt để xem trước tài liệu GitHub Flavored Markdown trên ổ đĩa cục bộ của mình trước khi đưa chúng vào GitHub, vì vậy hôm nay tôi đã tạo một cái, dựa trên Node.js: https : //github.com/ypocat/gfms

Vì vậy, có lẽ bạn có thể sử dụng lại showdown.js từ Wiki cho Wiki của mình, nếu câu hỏi của bạn vẫn còn thực tế. Nếu không, có lẽ những người khác phải đối mặt với cùng một vấn đề như tôi đã tìm thấy (giống như tôi đã làm) câu hỏi này và câu trả lời cho nó.

Để đọc tệp README.md trong thiết bị đầu cuối, tôi sử dụng:

pandoc README.md | lynx -stdin

Pandoc xuất nó ở định dạng HTML, mà Lynx kết xuất trong thiết bị đầu cuối của bạn.

Nó hoạt động rất tốt: Nó lấp đầy thiết bị đầu cuối của tôi, các phím tắt được hiển thị bên dưới, tôi có thể cuộn qua và các liên kết hoạt động! Chỉ có một kích thước phông chữ, nhưng màu sắc + thụt lề + căn chỉnh tạo nên điều đó.

Cài đặt:

sudo apt-get install pandoc lynx

GitHub có API Markdown mà bạn có thể sử dụng.

Sử dụng đánh dấu . Nó hỗ trợ GitHub Flavored Markdown, có thể được sử dụng như một mô-đun Node.js và từ dòng lệnh.

Một ví dụ sẽ là:

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

Đây chủ yếu là câu trả lời tiếp theo cho câu trả lời của @ barry- staes khi sử dụng Pandoc . Homebrew cũng có nó, nếu bạn đang dùng Mac:

brew install pandoc

Pandoc hỗ trợ GFM như một định dạng đầu vào thông qua markdown_githubtên.

Xuất ra tệp

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

Mở trong Lynx

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

Mở trong trình duyệt mặc định trên OS X

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

Tích hợp TextMate

Bạn luôn có thể chuyển lựa chọn hiện tại hoặc tài liệu hiện tại sang một trong những điều trên, vì hầu hết các biên tập viên đều cho phép bạn làm. Bạn cũng có thể dễ dàng định cấu hình môi trường để pandocthay thế bộ xử lý Markdown mặc định được sử dụng bởi gói Markdown .

Đầu tiên, tạo tập lệnh shell với nội dung sau (Tôi sẽ gọi nó ghmarkdown):

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

Sau đó, bạn có thể đặt TM_MARKDOWNbiến (trong Tùy chọn → Biến) thành /path/to/ghmarkdownvà nó sẽ thay thế bộ xử lý Markdown mặc định.

Tôi đã tạo một công cụ tương tự như chức năng Xem trước của Atom, nhưng là một ứng dụng độc lập. Không chắc chắn nếu đây là những gì bạn đang tìm kiếm, nhưng nó có thể hữu ích. - https://github.com/yoshuawuyts/vmd

pandocvới browsercông việc tốt cho tôi.

Sử dụng: cat README.md | pandoc -f markdown_github | browser

Cài đặt (Giả sử bạn đang sử dụng Mac OSX):

• $ brew install pandoc

• $ brew install browser

Hoặc trên Debian / Ubuntu: apt-get install pandoc browser

Đồng thời xem https://softwareengineering.stackexchange.com/a/128721/24257 .

Nếu bạn quan tâm đến cách chúng tôi [Github] kết xuất các tệp Markdown, bạn có thể muốn kiểm tra Redcarpet , giao diện Ruby của chúng tôi đến thư viện Sundown.

Ruby-script, sử dụng Redcarpet , sẽ là "tiện ích dòng lệnh", nếu bạn có Ruby cục bộ

Dựa trên nhận xét này, tôi đã viết một lớp lót để đánh API Github Markdown bằng cách sử dụng curlvà jq.

Dán chức năng bash này vào dòng lệnh hoặc vào ~/.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"
}

Và sau đó để xem HTML được hiển thị trong trình duyệt chạy:

mdsee readme.md

Thay thế open "$HTMLFILE"bằng lynx "$HTMLFILE"nếu bạn cần một giải pháp thiết bị đầu cuối thuần túy.

GitHub đã (từ đó) phát triển một trình soạn thảo văn bản mô-đun đẹp có tên là Atom (dựa trên Chromium và sử dụng các mô-đun Node.js cho các gói).

Gói cài đặt sẵn mặc định Markdown Preview cho phép bạn hiển thị bản xem trước của mình trong một tab riêng bằng cách sử dụng Ctrl+Shift + M.

Tôi chưa kiểm tra cú pháp đầy đủ của nó, nhưng vì nó đến từ GitHub, tôi rất ngạc nhiên nếu cú ​​pháp của bản xem trước khác với cú pháp của họ (các khối được rào chắn bằng cách sử dụng ~~~ công việc).

Bây giờ, mặc dù không dựa trên dòng lệnh về mặt kỹ thuật, nó sử dụng Node.js và xuất ra trình kết xuất dựa trên DOM , có thể giúp bất kỳ ai cố gắng kết xuất HTML dựa trên cú pháp GitHub trên máy chủ web dựa trên Node.js hoặc chỉ cần chỉnh sửa / README.md của mình nhé.

Giải pháp cuối cùng của tôi là sử dụng Python Markdown . Tôi cuộn phần mở rộng của riêng mình mà cố định các khối hàng rào.

Có một công cụ thực sự hay và đơn giản để duyệt các tài liệu của GFM Markdown:

GFMS - Máy chủ Markdown hương vị Github

Máy chủ HTTP đơn giản và gọn nhẹ (không cần cấu hình), bạn có thể bắt đầu trong bất kỳ thư mục nào chứa các tệp markdown để duyệt chúng.

Đặc trưng:

• Hỗ trợ đầy đủ GFM Markdown
• Làm nổi bật cú pháp mã nguồn
• Duyệt tập tin và thư mục
• Đầu ra đẹp mắt (và các bảng định kiểu CSS có thể định cấu hình)
• Xuất ra PDF

Tôi đã quản lý để sử dụng tập lệnh Ruby một dòng cho mục đích đó (mặc dù nó phải đi trong một tệp riêng). Đầu tiên, hãy chạy các lệnh này một lần trên mỗi máy khách, bạn sẽ đẩy tài liệu từ:

gem install github-markup
gem install commonmarker

Tiếp theo, cài đặt tập lệnh này trong hình ảnh máy khách của bạn và gọi nó render-readme-for-javadoc.rb:

require 'github/markup'

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

Cuối cùng, gọi nó như thế này:

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

ETA: Điều này sẽ không giúp bạn với Markdown của StackOverflow, dường như không thành công với câu trả lời này.

Tôi sử dụng Pandoc với tùy chọn --from=gfmcho GitHub Flavored Markdown như thế này:

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

Cải thiện giải pháp của @ barry-stae. Dán đoạn mã này trong ~ / .bashrc

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

Sau đó chúng ta có thể nhanh chóng xem tệp từ dòng lệnh. Cũng hoạt động độc đáo qua các phiên SSH / Telnet.

mdviewer README.md

Ngoài ra, nhưng showdownjs có một công cụ CLI mà bạn có thể sử dụng để phân tích MD thành HTML.

Tôi tìm thấy một trang web sẽ làm điều này cho bạn: http://tmpvar.com/markdown.html . Dán vào Markdown của bạn và nó sẽ hiển thị nó cho bạn. Có vẻ như chỉ hoạt động tốt!

Tuy nhiên, nó dường như không xử lý tùy chọn tô sáng cú pháp cho mã; đó là, ~~~rubytính năng không hoạt động. Nó chỉ in 'ruby'.

Cải thiện các câu trả lời @ barry-stae và @Sandeep cho người dùng thường xuyên sử dụng elinks, bạn sẽ thêm phần sau vào .bashrc:

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

Đừng quên cài đặt pandoc (và elinks).

Dựa trên câu trả lời của Jim Lim , tôi đã cài đặt đá quý GitHub Markdown. Điều đó bao gồm một tập lệnh gọi là gfm lấy tên tệp trên dòng lệnh và ghi HTML tương đương vào đầu ra tiêu chuẩn. Tôi đã sửa đổi một chút để lưu tệp vào đĩa và sau đó mở trình duyệt chuẩn bằng 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)

Cách tiếp cận 'nhanh và bẩn' là tải xuống các trang wiki HTML bằng wgettiện ích, thay vì nhân bản nó. Ví dụ: đây là cách tôi đã tải xuống wiki Hystrix từ GitHub (Tôi đang sử dụng 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

Cuộc gọi đầu tiên sẽ tải xuống trang nhập wiki và tất cả các phụ thuộc của nó. Cái thứ hai sẽ gọi tất cả các trang phụ trên đó. Bạn có thể duyệt wiki bây giờ bằng cách mở Netflix/Hystrix/wiki.1.html.

Lưu ý rằng cả hai cuộc gọi wgetlà cần thiết. Nếu bạn chỉ chạy cái thứ hai thì bạn sẽ bỏ lỡ một số phụ thuộc cần thiết để hiển thị các trang đúng cách.

Gần đây tôi đã thực hiện những gì bạn muốn, bởi vì tôi cần tạo tài liệu từ các tệp Markdown và kiểu GitHub khá đẹp. Thử nó. Nó được viết bằng Node.js.

bạn gái