GitHub फ्लेवर्ड मार्कडाउन प्रदान करने के लिए कमांड लाइन उपयोगिता है?

414

मुझे आश्चर्य हो रहा है कि क्या कोई GitHub फ्लेवर्ड मार्कडाउन फ़ाइल लेने के लिए कमांड लाइन उपयोगिता है और इसे HTML में रेंडर करना है।

मैं वेबसाइट सामग्री बनाने के लिए एक GitHub विकि का उपयोग कर रहा हूँ। मैंने अपने सर्वर पर रिपॉजिटरी को क्लोन किया है और फिर इसे नियमित रूप से HTML में संसाधित करना चाहता हूं। यह मेरे लिए महत्वपूर्ण है कि GitHub पर जो दिखाई देता है वह वास्तव में मेरी वेबसाइट के लिए कैसा होना चाहिए। मैं वास्तव में के साथ सज्जित ब्लॉकों का उपयोग ~~~करना चाहूंगा, इसलिए मैं केवल मानक मार्कडाउन सिंटैक्स का उपयोग नहीं करूंगा।

मैंने जावास्क्रिप्ट लाइव पूर्वावलोकन सोच में थोड़ा सा देखा है मैं इसे Node.js में हुक कर सकता हूं, लेकिन वे कहते हैं कि यह पदावनत है। मैंने रेडकारपेट रिपॉजिटरी को देखा है, लेकिन यह ऐसा नहीं लगता है कि इसमें कमांड लाइन इंटरफ़ेस है।

मैंने अपना स्वयं का समाधान रोल किया, हालांकि, क्योंकि यहां कोई समाधान स्पष्ट रूप से दूसरों की तुलना में बेहतर नहीं है, मैं एक चयनित उत्तर के बिना सवाल छोड़ दूंगा।

— McLeopold
स्रोत

2

पुन :: अद्यतन: अगर मैंने --outब्राउज़र के बजाय HTML फ़ाइल को प्रस्तुत करने के लिए पकड़ में एक तर्क जोड़ा , तो क्या यह स्वीकार्य होगा?

— जो

@ जो कृपया वह विकल्प जोड़ें!

— bguiz

@McLeopold @bguiz ने केवल --exportविकल्प को तैनात किया , जो GFM और इसकी शैलियों को एक ही फाइल में प्रस्तुत करता है। क्या यह सवाल का जवाब देता है?

— जो

3

@McLeopold, जो एक सरल पुन: प्रयोज्य समाधान बनाकर पार्क से बाहर खटखटाया, उसे जवाब देने के लिए चाहते हो सकता है।

— जेम्स मैकमोहन

1

गितुब ही सूंडाउन का उपयोग करता है । देखें stackoverflow.com/a/7694931/632951

— पचेरियर

447

मैंने पायथन में एक छोटा सीएलआई लिखा और जीएफएम समर्थन जोड़ा। इसे ग्रिप (Github Readme Instant Preview) कहा जाता है ।

इसे स्थापित करें:

$ pip install grip

और इसका उपयोग करने के लिए, बस:

$ grip

फिर उस स्थान पर फ़ाइल localhost:5000देखने के लिए जाएं readme.md।

आप अपनी खुद की फ़ाइल भी निर्दिष्ट कर सकते हैं:

$ grip CHANGES.md

और पोर्ट बदलें:

$ grip 8080

और निश्चित रूप से, विशेष रूप से गिटहब-फ्लेवर्ड मार्कडाउन को प्रस्तुत करते हैं, वैकल्पिक रूप से रिपॉजिटरी संदर्भ के साथ:

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

उल्लेखनीय विशेषताएं:

GitHub पर बिल्कुल दिखने के लिए रेंडर पेज
घने ब्लॉक
पायथन एपीआई
लिंक की गई फ़ाइलों के बीच नेविगेट करें (धन्यवाद, vladwing !) 2.0 में जोड़ा गया
2.0 में जोड़ा एक एकल फ़ाइल के लिए निर्यात (धन्यवाद, iliggio !)
नई: 3.0 में जोड़ा गया से stdinनिर्यात और पढ़ेंstdout

आशा है कि यह यहाँ किसी की मदद करता है। इसे देखें ।

— जो
स्रोत

1

वास्तव में अच्छी तरह से काम करता है और आप पाइथोनिस्टस के लिए आसानी से स्थापित नहीं कर सकते!

— रिचवेल

29

यह "जीथब मार्कडाउन प्रीव्यू" के लिए पहली हिट होनी चाहिए। बाकी सब कुछ जटिल है, काम नहीं करता है, या सभी GitHub सुविधाओं को नहीं करता है। gripसही बॉक्स से बाहर काम करता है।

— ब्लू 16

1

@ हौदिनी यह मुद्दा पुराना है। फ्लास्क 3.3 का समर्थन करता है, फ्लास्क देखें । pocoo.org/docs/python3 । यहाँ github.com/mitsuhiko/flask/issues/587 विषय पर एक और हाल ही में Github धागा है । यदि कोई अन्य निर्भरता है जिसे अद्यतन करने की आवश्यकता है, तो समस्या या पुल अनुरोध को खोलने के लिए स्वतंत्र महसूस करें।

— जो

3

यह ध्यान दिया जाना चाहिए कि यदि आप प्रति घंटे 60 से अधिक रिफ्रेश करते हैं, तो इस पैकेज के लिए एक सक्रिय इंटरनेट कनेक्शन और आपके जीथुब प्रमाणीकरण क्रेडेंशियल (कमांड लाइन पर प्रदान) की आवश्यकता होती है।

— leo

13

जैसा कि पहले उल्लेख किया गया है, मुझे नहीं लगता कि यह एक विशेष रूप से महान समाधान है क्योंकि यह सभी इसे जीथब के पास जाता है और जीथब को आपके मार्कडाउन को प्रस्तुत करने के लिए मिलता है। इसे गितुब के उपयोग के साथ एक कार्यशील इंटरनेट कनेक्शन की आवश्यकता होती है, और यदि गितुब की मृत्यु हो जाती है तो यह उपकरण काम करना बंद कर देता है। मैं बल्कि एक पूरी तरह से ऑफ़लाइन समाधान होगा।

— Jez

114

मुझे GitHub के स्वाद वाले मार्कडाउन के लिए एक त्वरित और आसान तरीका नहीं मिला है, लेकिन मुझे थोड़ा और सामान्य संस्करण मिल गया है - पंडोक । यह मार्कडाउन, रेस्ट, एचटीएमएल और अन्य सहित / से कई प्रारूपों में परिवर्तित होता है।

मैंने Makefileसभी .md फ़ाइलों को .html में बदलने के लिए ( लेखन, मार्कडाउन और पंडोक में उदाहरण के लिए बड़े हिस्से में ) विकसित किया है :

# '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 $@

— एलिस्टर बुलमैन
स्रोत

4

मैं लगातार html के लिए एक मार्कडाउन फ़ाइल को परिवर्तित करने के लिए "वॉच पंडोक ..." का उपयोग कर रहा हूं, और क्रोम "लाइव पुनः लोड" एक्सटेंशन को वास्तविक समय प्राप्त करने के लिए "जहां मैं भी स्क्रॉल हूं" इसके साथ कार्यक्षमता, और यह बहुत अच्छा काम करता है । chrome.google.com/webstore/detail/livereload/…

— ब्रैड पार्क

1

पंडोक GFM ठीक पढ़ता है, लेकिन यह वही HTML GitHub उत्पन्न नहीं करता है - उदाहरण के लिए, यदि <pre/>आपके GFM स्रोत में मल्टी-लाइन टैग है, तो पंडोक <br/>इसमें लाइन ब्रेक के लिए टैग लगाएगा , जबकि GitHub के रेंडरर, हालांकि यह व्हॉट्सएप को अग्रणी बनाता है, अन्यथा सामग्री को अकेला छोड़ देता है।

— डेविड मोल्स

1

परिणामी HTML पर अच्छी स्टाइल पाने के बारे में कैसे जाना जाता है? मेरा आउटपुट अभी भी टाइम्स न्यू रोमन के साथ प्रदान किया गया है, उदाहरण के लिए।

— समग्र डेवलपर

पंडोक स्थापित निर्देश यहाँ हैं । MacOS पर:brew install pandoc

— मास्टर ऑफ डक

1

न तो gfmऔर न ही markdown_githubइनपुट प्रारूप कोड ब्लॉक जैसी चीजों को सही ढंग से प्रस्तुत करते हैं।

— user5359531

29

शायद यह मदद कर सकता है:

gem install github-markdown

कोई दस्तावेज मौजूद नहीं है, लेकिन मुझे यह गोलम के प्रलेखन से मिला । Rubydoc.info को देखकर ऐसा लगता है कि आप इसका उपयोग कर सकते हैं:

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

अपने रूबी कोड में। आप इसे आसानी से स्क्रिप्ट में कमांड लाइन उपयोगिता में बदल सकते हैं:

#!/usr/bin/env ruby

# render.rb
require 'github/markdown'

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

इसके साथ निष्पादित करें ./render.rb path/to/my/markdown/file.md। ध्यान दें कि यह स्वच्छता के बिना उत्पादन में उपयोग के लिए सुरक्षित नहीं है।

— जेम्स लिम
स्रोत

1

धन्यवाद जिम, वस्तुतः गैर-मौजूद उदाहरणों के कारण, मैं आवश्यक कदम पर अटक गया था (स्लैश के साथ पानी का छींटा बनाया गया था) ..;)

— plesatejvlk

यदि आप पहले से ही एनपीएम का उपयोग कर रहे हैं तो यह बहुत अच्छा है। मुझे इसका उपयोग करना पड़ा, डीओएक्सजेन के कारण मुझे विशेष रूप से जीथब-फ्लेवर्ड मार्कडाउन + के साथ लगातार समस्याएं पैदा हो रही थीं + एचटीएमएल को निर्यात करना।

— kayleeFrye_onDeck

क्या यह स्थानीय स्तर पर चल रहा है या यह GitHub API से डेटा भेज रहा है?

— user5359531

28

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

यह GitHub एक्सटेंशन को हैंडल नहीं करता है, लेकिन यह कुछ भी नहीं से बेहतर है। मेरा मानना है कि आप GitHub परिवर्धन को संभालने के लिए मॉड्यूल का विस्तार कर सकते हैं।

— ग्रिंगो सुवे
स्रोत

1

/ usr / bin / python:

— मार्कडाउन

2

बिना किसी फैंसी टैग के साथ सरल HTML आउटपुट।

— हालिल कासावक्लिसी

23

शायद नहीं जो आप चाहते हैं, लेकिन जब से आपने Node.js का उल्लेख किया है: मुझे GitHub के लिए प्रतिबद्ध करने से पहले अपने स्थानीय ड्राइव पर GitHub Flavoured Markdown प्रलेखन का पूर्वावलोकन करने के लिए एक अच्छा उपकरण नहीं मिला, इसलिए आज मैंने Node.js: https के आधार पर एक बनाया। : //github.com/ypocat/gfms

तो शायद आप अपने विकी के लिए शोडाउन को फिर से उपयोग कर सकते हैं, यदि आपका प्रश्न अभी भी वास्तविक है। यदि नहीं, तो शायद अन्य लोगों को भी वैसी ही समस्या का सामना करना पड़ रहा है जैसा कि मैंने किया था (जैसा मैंने किया) यह सवाल और इसका जवाब है।

— youurayy
स्रोत

अच्छा हुआ, यार। जब मैं एक नोड आवेदन लिख रहा हूं, जो कि बहुत अच्छा है, तो मुझे रूबी या पायथन का सहारा लेने से बचाता है।

— jedd.ahyoung 21

19

मेरे द्वारा उपयोग किए जाने वाले टर्मिनल में एक README.md फ़ाइल पढ़ने के लिए:

pandoc README.md | lynx -stdin

पंडोक इसे HTML प्रारूप में आउटपुट करता है, जो आपके टर्मिनल में लिंक्स प्रस्तुत करता है।

यह महान काम करता है: यह मेरे टर्मिनल को भरता है, शॉर्टकट नीचे दिखाए गए हैं, मैं स्क्रॉल कर सकता हूं, और लिंक काम कर सकते हैं! हालांकि केवल एक फ़ॉन्ट आकार है, लेकिन रंग + इंडेंटेशन + संरेखण उसके लिए बनाते हैं।

स्थापना:

sudo apt-get install pandoc lynx

— बैरी स्टैस
स्रोत

1

प्रश्न विशेष रूप से कमांड-लाइन उपयोग के बारे में है। अपनी खुद की रूबी स्क्रिप्ट (या उदाहरण के लिए नोड सर्वर) लिखने से पहले, इसे एक शॉट दें।

— Cora Middleton

वास्तव में यह आपके टर्मिनल के अंदर काम करता है। या यदि आपका पसंदीदा (डेस्कटॉप?) ब्राउज़र उस फ़ोल्डर का उपयोग कर सकता है pandoc readme.md -o readme.md.htmlऔर परिणामी फ़ाइल को खोल सकता है।

— बैरी स्टास

@ baerry-staes हां, क्षमा करें, मुझे आशा है कि यह स्पष्ट था कि आपका मेरा पसंदीदा उत्तर था।

— कोरा मिडलटन

@JustinMiddleton हाँ मुझे वह मिला, धन्यवाद। मेरी टिप्पणी सिर्फ डेस्कटॉप उपयोगकर्ताओं के लिए कुछ अतिरिक्त जानकारी जोड़ने के लिए थी .. मुझे किसी दिन यह पढ़कर लगा कि यह उपयोगी हो सकता है।

— बैरी स्टेस

1

मैंने लगभग 5-6 अन्य कंसोल एमडी पाठकों की कोशिश की है और यह अब तक का सबसे अच्छा समाधान है। मैंने इसे उपयोग करने के लिए थोड़ा तेज़ बनाने के लिए अपने कॉन्फिग में सबसे बुनियादी फंक्शन जोड़ा। function md { pandoc $@ | lynx -stdin }

— रस ब्राउन

17

GitHub में एक मार्कडाउन एपीआई है जिसका आप उपयोग कर सकते हैं।

— kehers
स्रोत

5

jq --slurp --raw-input  '{"text": "\(.)", "mode": "markdown"}' < README.md | curl --data @- https://api.github.com/markdown > README.html

— वेबजर्न लोजोसा

@VebjornLjosa * कि * या grip... आपने चुना। : पी

— yyny

13

चिह्नित का उपयोग करें । यह GitHub Flavoured Markdown का समर्थन करता है, इसका उपयोग Node.js मॉड्यूल के रूप में और कमांड लाइन से किया जा सकता है।

एक उदाहरण होगा:

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

— zemirco
स्रोत

1

मैंने देखा है कि यह कोड ब्लॉक के लिए सिंटैक्स हाइलाइटिंग और चेकलिस्ट की तरह नई सुविधाओं का समर्थन नहीं करता है। लेकिन हे, यह सबसे अधिक हो जाता है!

— bguiz

बहुत अच्छा है, केवल एक चीज जो मुझे याद आ रही है वह है तालिकाओं के लिए कुछ सीमाएँ। ठीक है, कम से कम मैं उन्हें बिल्कुल सौंप सकता हूं, यह वास्तव में बहुत अधिक है जो मुझे चाहिए। GFM में पाइप, HTML :)

— Xandaros

मैं इस उदाहरण के बारे में उलझन में हूं, क्या है ^D?

— मत्ती

10

यह ज्यादातर पंडोक का उपयोग करने के लिए @ बैरी-स्टैस के उत्तर का अनुसरण है । Homebrew यह भी है, अगर आप एक मैक पर हैं:

brew install pandoc

पंडोक markdown_githubनाम के माध्यम से इनपुट प्रारूप के रूप में GFM का समर्थन करता है ।

फाइल करने के लिए आउटपुट

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

लिंक्स में खोलें

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

ओएस एक्स पर डिफ़ॉल्ट ब्राउज़र में खोलें

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

TextMate एकीकरण

आप हमेशा उपरोक्त में से किसी एक के लिए वर्तमान चयन या वर्तमान दस्तावेज़ को पाइप कर सकते हैं, क्योंकि अधिकांश संपादक आपको करने की अनुमति देते हैं। तुम भी आसानी से वातावरण कॉन्फ़िगर कर सकते हैं ताकि pandocद्वारा इस्तेमाल किया डिफ़ॉल्ट Markdown प्रोसेसर की जगह Markdown बंडल ।

सबसे पहले, निम्न सामग्री के साथ एक शेल स्क्रिप्ट बनाएं (मैं इसे कॉल करूंगा ghmarkdown):

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

फिर आप TM_MARKDOWNचर (प्राथमिकताएँ → चर) में सेट कर सकते हैं /path/to/ghmarkdown, और यह डिफ़ॉल्ट मार्कडाउन प्रोसेसर को बदल देगा।

— कोरा मिडलटन
स्रोत

10

मैंने एटम की पूर्वावलोकन कार्यक्षमता के समान एक उपकरण बनाया, लेकिन एक स्टैंडअलोन एप्लिकेशन के रूप में। सुनिश्चित नहीं हैं कि यह वही है जो आप खोज रहे हैं, लेकिन यह मददगार हो सकता है। - https://github.com/yoshuawuyts/vmd

VMD

— योशुआ वुट्स
स्रोत

आप लोग अब भी इसका समर्थन कर रहे हैं? मैंने आज एनपीएम के साथ स्थापित करने की कोशिश की, लेकिन कोई पासा नहीं। > इलेक्ट्रॉन

— डाउनलोडिंग-v0.36.9-win32-x64.zip

1

हाँ, हम हैं! Npm / नोड के किस संस्करण पर आपने इसे चलाया? - जीएच पर एक मुद्दे को खोलने के लिए स्वतंत्र महसूस करें और हम इस पर एक नज़र डालेंगे। धन्यवाद!

— योशुआ वूट्स

8

pandocसाथ browserअच्छी तरह से मेरे लिए काम करता है।

उपयोग: cat README.md | pandoc -f markdown_github | browser

स्थापना (यह मानते हुए कि आप Mac OSX का उपयोग कर रहे हैं):

$ brew install pandoc
$ brew install browser

या डेबियन / उबंटू पर: apt-get install pandoc browser

— binarymason
स्रोत

1

apt-get isntall pandocकरेगा, असुरक्षित उपयोग करने के लिए कोई ज़रूरत नहीं है, काढ़ा की तरह स्थानीय सामान।

— डोमिनिक जॉर्ज

1

@DominikGeorge में एक टाइपो है, यह स्थापित है , isntall

— फेडेरिको टोमासेटी

11

@DominikGeorge macOS पर कोई उपयुक्त नहीं है।

— रिचड्रेड

6

इसके अलावा https://softwareengineering.stackexchange.com/a/128721/24257 देखें ।

यदि आप रुचि रखते हैं कि हम कैसे [गिटब] मार्कडाउन फ़ाइलों को प्रस्तुत करते हैं, तो आप रेडकारपेट , सुंडी पुस्तकालय के लिए हमारे रूबी इंटरफ़ेस की जांच कर सकते हैं ।

रूबी-स्क्रिप्ट, जो Redcarpet का उपयोग करती है , "कमांड लाइन उपयोगिता" होगी, यदि आपके पास स्थानीय रूबी होगी

— आलसी बेजर
स्रोत

विचार नहीं - मैं रूबी नहीं लिखता और मैंने रेडकारपेट स्रोतों को नहीं पढ़ा

— आलसी बेजर

@LazyBadger, Sundown वास्तविक पार्सर (C में लिखा गया) है। रेडकारपेट की जरूरत नहीं है।

— पचेरियर

6

पर बिल्डिंग इस टिप्पणी मैं एक एक लाइनर हिट करने के लिए लिखा था Github Markdown एपीआई का उपयोग कर curlऔर jq।

इस बैश फ़ंक्शन को कमांड लाइन पर या अपने में चिपकाएँ ~/.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"
}

और फिर रेंडर किए गए HTML इन-ब्राउज़र रन को देखने के लिए:

mdsee readme.md

बदलें open "$HTMLFILE"के साथ lynx "$HTMLFILE"यदि आप एक शुद्ध टर्मिनल समाधान की जरूरत है।

— notpeter
स्रोत

4

GitHub ने परमाणु (क्रोमियम पर आधारित और संकुल के लिए Node.js मॉड्यूल का उपयोग करता है) नामक एक अच्छा मॉड्यूलर पाठ संपादक विकसित किया है ।

डिफ़ॉल्ट प्रीइंस्टॉल्ड पैकेज मार्कडाउन पूर्वावलोकन आपको Ctrl+ Shift+ का उपयोग करके एक अलग टैब में अपना पूर्वावलोकन प्रदर्शित करने देता है M।

मैंने इसके पूर्ण सिंटैक्स का परीक्षण नहीं किया है, लेकिन चूंकि यह GitHub से आ रहा है, मुझे बहुत आश्चर्य होगा अगर पूर्वावलोकन का सिंटैक्स उनके ( ~~~काम का उपयोग करने वाले ब्लॉक से अलग था )।

अब, जबकि यह तकनीकी रूप से कमांड लाइन आधारित नहीं है, यह Node.js और आउटपुट एक करने के लिए उपयोग करता डोम आधारित रेंडरर, जिस पर एक GitHub वाक्य रचना आधारित HTML रेंडर करने के लिए कोशिश कर रहा हो सकता है मदद किसी को भी Node.js आधारित वेब सर्वर, या बस संपादित उसकी / उसकी README.md ऑफ़लाइन।

— Que
स्रोत

1

एटम में आप gfm-pdf ( atom.io/packages/gfm-pdf ) नामक एक पैकेज स्थापित कर सकते हैं , जो आपके मार्कडाउन दस्तावेज़ को HTML और / या PDF दस्तावेज़ में निर्यात करता है। पुस्तकालय wkhtmltopdf की आवश्यकता है।

— spren9er

3

मेरा अंतिम उपाय पायथन मार्कडाउन का उपयोग करना था । मैंने अपने स्वयं के विस्तार को लुढ़का दिया जो बाड़ ब्लॉकों को तय करता था।

— McLeopold
स्रोत

3

GFM मार्कडाउन दस्तावेज़ ब्राउज़ करने के लिए एक बहुत अच्छा और सरल उपकरण है:

जीएफएमएस - जीथब फ्लेवर्ड मार्कडाउन सर्वर

यह सरल और हल्का है (कोई कॉन्फ़िगरेशन की आवश्यकता नहीं) HTTP सर्वर आप उन्हें ब्राउज़ करने के लिए किसी भी निर्देशिका में मार्कडाउन फ़ाइलों से शुरू कर सकते हैं।

विशेषताएं:

पूर्ण GFM मार्कडाउन समर्थन
स्रोत कोड सिंटैक्स हाइलाइटिंग
फ़ाइलों और निर्देशिकाओं को ब्राउज़ करना
अच्छी लग रही उत्पादन (और विन्यास सीएसएस स्टाइलशीट)
पीडीएफ को निर्यात करें

— पावेल विजाचा
स्रोत

3

मैं उस उद्देश्य के लिए एक-पंक्ति रूबी स्क्रिप्ट का उपयोग करने में कामयाब रहा (हालांकि इसे एक अलग फ़ाइल में जाना था)। सबसे पहले, इन आदेशों को एक बार प्रत्येक ग्राहक मशीन पर चलाएं जिन्हें आप डॉक्स से आगे बढ़ाएंगे:

gem install github-markup
gem install commonmarker

इसके बाद, अपनी क्लाइंट छवि में इस स्क्रिप्ट को स्थापित करें, और इसे कॉल करें render-readme-for-javadoc.rb:

require 'github/markup'

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

अंत में, इसे इस तरह लागू करें:

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

ईटीए: यह आपको स्टैकऑवरफ्लो-फ्लेवर मार्कडाउन के साथ मदद नहीं करेगा, जो इस उत्तर पर विफल हो रहा है।

— Pr0methean
स्रोत

मुझे लगता है कि यह उन सभी में से "सबसे करीबी स्रोत" उत्तर है क्योंकि ये उपकरण जीथब द्वारा उपयोग किए गए हैं।

— 14

3

मैं --from=gfmGitHub फ्लेवर्ड मार्कडाउन के विकल्प के साथ पंडोक का उपयोग करता हूं :

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

— ऐसमे जस्ट
स्रोत

लिनक्स टकसाल 18 पर pandoc 1.16.0.2 के साथ मुझे एक त्रुटि मिलती है pandoc: Unknown reader: gfm:। 2.2.1 पर जाने से यह ठीक हो जाता है।

— अपहरण कर लें

मैंने पंडोक 2.1.2 के साथ इसका परीक्षण किया।

— असीम जस्ट

ubuntu पर 2.2.1 कैसे स्थापित करें?

— अलेक्जेंडर मिल्स

@AlexanderMills क्या आपने कोशिश की sudo apt install pandoc?

— असीम जस्ट

2

@ बैरी-स्टा के समाधान में सुधार। इस स्निपेट को ~ / .bashrc में चिपका दें

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

फिर हम कमांड-लाइन से फाइल को जल्दी देख सकते हैं। इसके अलावा SSH / टेलनेट सत्रों पर अच्छी तरह से काम करता है।

mdviewer README.md

— संदीप
स्रोत

2

देर से जोड़ लेकिन showdownjs में एक CLI उपकरण होता है जिसका उपयोग आप MD को HTML में पार्स करने के लिए कर सकते हैं।

— Tivie
स्रोत

1

मुझे एक वेबसाइट मिली, जो आपके लिए यह करेगी: http://tmpvar.com/markdown.html । अपने मार्कडाउन में पेस्ट करें, और यह आपके लिए प्रदर्शित करेगा। यह ठीक काम करने लगता है!

हालाँकि, यह कोड के लिए सिंटैक्स हाइलाइटिंग विकल्प को संभालने के लिए प्रतीत नहीं होता है; यह है, ~~~rubyसुविधा काम नहीं करती है। यह सिर्फ 'माणिक' छापता है।

— JESii
स्रोत

tmpvar ने gfm संस्करण संवर्द्धन टेबल की तरह नहीं किया

— ग्रेग

0

एलिक्स के नियमित उपयोगकर्ताओं के लिए @ बैरी-स्टा और @संदीप उत्तरों में सुधार करने पर आप निम्नलिखित।

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

पैंडोक (और एलिंक) को स्थापित करने के लिए मत भूलना।

— daBertl
स्रोत

0

जिम लिम के जवाब के आधार पर , मैंने गिटहब मार्कडाउन रत्न स्थापित किया। इसमें gfm नामक एक स्क्रिप्ट शामिल है जो कमांड लाइन पर फ़ाइल नाम लेता है और मानक आउटपुट के बराबर HTML लिखता है। मैंने उस फ़ाइल को डिस्क में सहेजने के लिए और फिर लॉन्च के साथ मानक ब्राउज़र को खोलने के लिए थोड़ा संशोधित किया:

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

— gerrard00
स्रोत

1

मैंने रूबी और ककड़ी के लिए fenced ब्लॉकों के साथ यह कोशिश की। जबकि बाड़ ( ruby, ककड़ी, आदि) को बाड़ के रूप में पहचाना जाता है (क्योंकि वे तय चौड़ाई पाठ में प्रदान किए जाते हैं), कोई वाक्यविन्यास हाइलाइटिंग नहीं है। कोई विचार क्यों?

— कीथ बेनेट

0

एक 'क्विक एंड-डर्टी' दृष्टिकोण का उपयोग करके wgetक्लोन करने के बजाय, उपयोगिता का उपयोग करते हुए विकी HTML पृष्ठों को डाउनलोड करना है। उदाहरण के लिए, यह है कि मैंने GitHub (मैं Ubuntu लिनक्स का उपयोग कर रहा हूं ) से हिस्टिक्स विकी डाउनलोड किया है। )

 $ 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

पहला कॉल विकी एंट्री पेज और उसके सभी आश्रितों को डाउनलोड करेगा। दूसरा उस पर सभी उप-पृष्ठ कॉल करेगा। आप अब खोलकर विकी ब्राउज़ कर सकते हैं Netflix/Hystrix/wiki.1.html।

ध्यान दें कि दोनों कॉल wgetआवश्यक हैं। यदि आप दूसरे को चलाते हैं तो आपको पृष्ठों को ठीक से दिखाने के लिए आवश्यक कुछ निर्भरताएँ याद आती हैं।

— लुइस रोडेरो-मेरिनो
स्रोत

-1

मैंने हाल ही में बनाया है कि आप क्या चाहते हैं, क्योंकि मुझे मार्कडाउन फाइलों से प्रलेखन उत्पन्न करने की आवश्यकता थी और गिटहब शैली बहुत अच्छी है। कोशिश करो। यह Node.js. में लिखा गया है

GFM

— गेब्रियल लामास
स्रोत

मुझे पता है, मॉड्यूल 9 महीने में udated नहीं किया गया है, आप एक पुरानी पोस्ट को क्यों डाउन करते हैं?

— गैब्रियल लामास