[command-line] GitHub 맛의 Markdown을 렌더링하기위한 명령 행 유틸리티가 있습니까?



Answers

GitHub 맛의 Markdown을위한 빠르고 쉬운 방법을 찾지 못했지만 좀 더 일반적인 버전 인 Pandoc 발견했습니다. Markdown, Rest, HTML 및 기타 형식을 비롯한 다양한 형식으로 변환합니다.

또한 모든 .md 파일을 .html로 변환하는 Makefile 을 개발했습니다 (대부분 Writing, Markdown 및 Pandoc 의 예제 와 같습니다 ).

# 'Makefile'
MARKDOWN = pandoc --from markdown_github --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 $@
Question

GitHub 맛의 Markdown 파일을 HTML로 렌더링하는 명령 줄 유틸리티가 있는지 궁금합니다.

GitHub 위키를 사용하여 웹 사이트 콘텐츠를 만듭니다. 내 서버에 저장소를 복제 한 다음 일반 HTML로 처리하려고합니다. GitHub에 나타나는 것은 정확히 내 웹 사이트를 찾는 방법입니다. 나는 또한 ~~~ 울타리 블록을 사용하고 싶다. 그래서 표준 Markdown 구문만을 사용하고 싶다.

자바 스크립트 라이브 미리보기에서 Node.js에 연결할 수 있다고 생각했지만 사용되지 않습니다. redcarpet 저장소를 살펴 보았지만 명령 행 인터페이스가없는 것 같습니다.

나는 여기에 해결책이 다른 것보다 낫기 때문에 내 자신의 솔루션을 굴렸다. 나는 선택된 대답없이 질문을 떠날 것이다.




나는 Pandoc을 --from=gfm 옵션과 함께 다음과 같이 사용한다.

$ pandoc markdown-sample.md   --from=gfm -t html -o markdown-sample.html



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

그것은 GitHub 확장을 처리하지 않지만 아무것도 아닌 것보다 낫습니다. GitHub 추가 기능을 처리하도록 모듈을 확장 할 수 있다고 생각합니다.




GFM Markdown 문서를 탐색하기위한 정말 멋지고 간단한 도구가 있습니다.

GFMS - Github Flavored Markdown Server

간단하고 가벼운 (구성 필요 없음) HTTP 서버. 마크 다운 파일이있는 디렉토리에서 시작할 수 있습니다.

풍모:

  • 전체 GFM 마크 다운 지원
  • 소스 코드 구문 강조
  • 파일 및 디렉토리 탐색
  • 보기 좋은 출력 (및 구성 가능한 CSS 스타일 시트)
  • PDF로 내보내기



터미널에서 README.md 파일을 읽으려면 다음을 사용하십시오.

pandoc README.md | lynx -stdin

Pandoc은 Lynx가 터미널에서 렌더링하는 HTML 형식으로 출력합니다.

그것은 위대한 작품 : 내 터미널을 채우고, 바로 가기가 아래에 표시됩니다, 내가 스크롤 할 수 있으며, 링크가 작동! 그러나 글꼴 크기는 하나 뿐이지 만 색상 + 들여 쓰기 + 맞춤이 그 점을 보완합니다.

설치:

sudo apt-get install pandoc lynx






Atom의 미리보기 기능과 비슷한 도구를 만들었지 만 독립 실행 형 응용 프로그램으로 만들었습니다. 이것이 당신이 찾고있는 것이라면 확실하지 않지만 도움이 될 것입니다. - https://github.com/yoshuawuyts/vmd




늦어졌지만 showdownjs 에는 MD를 HTML로 구문 분석하는 데 사용할 수있는 CLI 도구가 있습니다.




나는 Markdown 파일에서 문서를 생성 할 필요가 있고 GitHub 스타일이 꽤 좋기 때문에 최근에 내가 원하는 것을 만들었습니다. 시도 해봐. Node.js로 작성되었습니다.

gfm







Jim Lim의 답변을 바탕으로 GitHub Markdown gem을 설치했습니다. 명령 줄에서 파일 이름을 사용하고 해당 HTML을 표준 출력에 쓰는 gfm 스크립트가 포함되었습니다. 파일을 디스크에 저장 한 다음 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)



@ barry-stae의 솔루션 개선. 이 스 니펫을 ~ / .bashrc에 고정하십시오.

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

그런 다음 명령 줄에서 파일을 빠르게 볼 수 있습니다. 또한 SSH / 텔넷 세션에서 잘 작동합니다.

mdviewer README.md



Links