गीथूब पर README.md में लेटेक्स का प्रतिपादन

Question

वहाँ एक GitHub भंडार में README.md में LaTex प्रस्तुत करने का कोई तरीका है? मैंने इसे देखा है और स्टैक ओवरफ्लो पर खोज की है, लेकिन संबंधित उत्तरों में से कोई भी संभव नहीं है।

Comments

यह सीधे तौर पर संभव नहीं है। क्या कुछ विशिष्ट बात है जो आपको लगता है कि आपको LaTex की आवश्यकता है? उदाहरण के लिए, यदि आप गणित के समीकरण चाहते हैं, तो कुछ विशिष्ट ट्रिक्स के साथ यह संभव हो सकता है। हमें बताएं कि आप क्या प्रस्तुत करना चाहते हैं, और कोई व्यक्ति आपको वर्कअराउंड करने में सक्षम हो सकता है।

— वायलन

हां, मैं गणित के समीकरणों और संरेखित समीकरणों के साथ-साथ अंतर्निर्मित गणित प्रतीकों को भी चाहता हूं। तो इतना ही है।

— user90593

इस संबंधित पोस्ट को देखें: सामान्य गिटहब के मार्कडाउन में गणित के समीकरणों को कैसे दिखाया जाए (जीथब का ब्लॉग नहीं) ।

— वायलन

इसके अलावा: गितुब विकिस में लाटेक्स गणित ।

— वायलन

क्या आपने बृहस्पति पुस्तिकाओं का उपयोग करने पर विचार किया है? आप अब अजगर कोड भी डाल सकते हैं;)

— चार्ली पार्कर

Answer 1

शॉर्ट एक्सप्रेशन के लिए और इतने फैंसी गणित के लिए आप अपने इनटेक्स को गणित को कोडेक्सॉग्स पर लाने के लिए इनलाइन एचटीएमएल का उपयोग नहीं कर सकते हैं और फिर परिणामी छवि को एम्बेड कर सकते हैं। यहाँ एक उदाहरण है:

- <img src="https://latex.codecogs.com/gif.latex?O_t=\text { Onset event at time bin } t " /> 
- <img src="https://latex.codecogs.com/gif.latex?s=\text { sensor reading }  " /> 
- <img src="https://latex.codecogs.com/gif.latex?P(s | O_t )=\text { Probability of a sensor reading value when sleep onset is observed at a time bin } t " />

जिसका परिणाम अगले जैसा कुछ होना चाहिए

अपडेट: यह ग्रहण में बहुत अच्छा काम करता है लेकिन दुर्भाग्य से नहीं। चारों ओर एकमात्र काम अगला है:

अपने लेटेक्स समीकरण को लें और http://www.codecogs.com/latex/eqneditor.php पर जाएं , उस क्षेत्र के निचले भाग में जहाँ आपका समीकरण प्रदर्शित होता है, एक छोटा ड्रॉपडाउन मेनू है, URL एन्कोडेड चुनें और फिर अपने में चिपकाएँ अगले तरीके से जीथब मार्कडाउन:

![equation](http://latex.codecogs.com/gif.latex?O_t%3D%5Ctext%20%7B%20Onset%20event%20at%20time%20bin%20%7D%20t)
![equation](http://latex.codecogs.com/gif.latex?s%3D%5Ctext%20%7B%20sensor%20reading%20%7D) 
![equation](http://latex.codecogs.com/gif.latex?P%28s%20%7C%20O_t%20%29%3D%5Ctext%20%7B%20Probability%20of%20a%20sensor%20reading%20value%20when%20sleep%20onset%20is%20observed%20at%20a%20time%20bin%20%7D%20t)

Comments

मेरा सुझाव है कि latex.codecogs.com/png.latex के बजाय latex.codecogs.com/gif.latex का उपयोग करने का सुझाव दें ; यह बेहतर गुणवत्ता के चित्र देता है!

— स्टेफो

आप latex.codecogs.com/svg.latex का उपयोग कर सकते हैं, यह संकल्प स्वतंत्र है।

— लिजफायरमैन

Answer 2

मैं Gitlab के समीकरणों के साथ रिपॉजिटरी अपलोड करता हूं क्योंकि इसमें LaTeX के लिए देशी समर्थन है। Md फाइलें:

```math
SE = \frac{\sigma}{\sqrt{n}}
```

इनलाइन लेटेक्स के लिए सिंटैक्स है $`\sqrt{2}`$।

गिटलैब छवियों को दिखाने के बजाय ब्राउज़र में जावास्क्रिप्ट के साथ समीकरणों का प्रतिपादन करता है, जिससे समीकरणों की गुणवत्ता में सुधार होता है।

अधिक जानकारी यहाँ ।

आशा करते हैं कि गितुब भविष्य में भी इसे लागू करेगा।

Comments

गजब का! टिप के लिए धन्यवाद :)

— जोनाथन एच।

क्या आप जानते हैं कि क्या GitHub ने इसे लागू किया है?

— रोलन शेफ़र

Answer 3

मेरी तरकीब है कि जुपिटर नोटबुक का उपयोग करें।

GitHub ने .ipynb फ़ाइलों को रेंडर करने के लिए बिल्ट-इन सपोर्ट दिया है। आप इनलाइन लिख सकते हैं और नोटबुक में LaTeX कोड प्रदर्शित कर सकते हैं और GitHub आपके लिए इसे प्रस्तुत करेगा।

यहाँ एक नमूना नोटबुक फ़ाइल है: https://gist.github.com/cyhsutw/d5983d166fb70ff651f027b2aa56ee4e

Answer 4

Readme2Tex

मैं एक पटकथा पर काम कर रहा है कि cruft के automates सबसे Github स्वाद markdown में LaTeX टाइपसेट अच्छी तरह से हो रही है से बाहर: https://github.com/leegao/readme2tex

Github के लिए LaTeX प्रदान करने के साथ कुछ चुनौतियां हैं। सबसे पहले, जीथब-फ्लेवर्ड मार्कडाउन सबसे टैग्स और अधिकांश विशेषताओं को स्ट्रिप्स करता है। इसका मतलब है कि कोई जावास्क्रिप्ट आधारित पुस्तकालय (जैसे मैथजैक्स) और न ही कोई सीएसएस स्टाइलिंग।

तब प्राकृतिक समाधान पूर्वनिर्मित समीकरणों की छवियों को एम्बेड करता प्रतीत होता है। हालाँकि, आप जल्द ही महसूस करेंगे कि LaTeX केवल डॉलर-चिन्ह संलग्न फॉर्मूलों को छवियों में बदलने से अधिक करता है।

बस ऑनलाइन संकलक से छवियों को एम्बेड करना आपके दस्तावेज़ को वास्तव में अप्राकृतिक रूप देता है। वास्तव में, मैं यह तर्क दूंगा कि यह आपके रोजमर्रा के एक्स ^ 2 से भी अधिक पठनीय है जो उछल कूद की तुलना में गणितीय है ।

मेरा मानना ​​है कि यह सुनिश्चित करना कि आपके दस्तावेज़ प्राकृतिक और पठनीय तरीके से टाइपसेट हैं, महत्वपूर्ण है। यही कारण है कि मैंने एक पटकथा लिखी है, जो सूत्रों में संकलित चित्रों से परे है, यह भी सुनिश्चित करता है कि परिणामी छवि को ठीक से फिट किया जाए और शेष पाठ के साथ संरेखित किया जाए।

उदाहरण के लिए, यहाँ .mdकुछ प्रकार के नियमित भाव टाइपसेट के गुणात्मक गुणों के बारे में एक फ़ाइल का एक अंश दिया गया है readme2tex:

जैसा कि आप उम्मीद कर सकते हैं, शीर्ष पर समीकरणों का सेट केवल संबंधित align*वातावरण शुरू करने से निर्दिष्ट होता है

**Theorem**: The translation $[\![e]\!]$ given by
\begin{align*}
...
\end{align*}
...

सूचना है कि जब इनलाइन समीकरणों ($ ... $) पाठ के साथ चलाने के लिए, प्रदर्शन समीकरण (उन है कि द्वारा सीमांकित कर रहे हैं \begin{ENV}...\end{ENV}या $$...$$) केंद्रित कर रहे हैं। यह उन लोगों के लिए आसान बनाता है जो पहले से ही उत्पादक होने के लिए LaTeX के आदी रहे हैं।

यदि यह कुछ ऐसा लगता है जो मदद कर सकता है, तो इसे देखना सुनिश्चित करें। https://github.com/leegao/readme2tex

Comments

इस काम के आधार पर मैंने एक GitHub ऐप बनाया है जो रेंडरिंग प्रक्रिया को स्वचालित करता है, हर बार एक धक्का देने पर इसे ट्रिगर किया जाता है। मुझे लगता है कि यह उपयोगी है इसलिए मैं उन लोगों के लिए लिंक साझा करता हूं जो इसे आजमाना चाहते हैं: github.com/agurz/github-texify

— agurodriguez

अच्छा! यह वास्तव में आप के लिए वास्तव में कमाल है :)

— ली

TeXify ऐप तब काम नहीं करता है जब मार्क किए गए आइटमों के लिए इनलाइन मैथजैक्स शामिल करें।

— user32882

Answer 5

कोई भी इस ऑनलाइन संपादक का उपयोग कर सकता है: https://www.codecogs.com/latex/eqneditor.php जो SVGमक्खी पर फाइलें उत्पन्न करता है। आप अपने दस्तावेज़ में इस तरह से एक लिंक डाल सकते हैं: ![](https://latex.codecogs.com/svg.latex?y%3Dx%5E2)जिसके परिणामस्वरूप :।

Answer 6

मैं दूसरों द्वारा प्रस्तावित कुछ समाधान का परीक्षण करता हूं और मैं एग्रोड्रोडिग्यूज़ द्वारा टिप्पणी में निर्मित और प्रस्तावित TeXify की सिफारिश करना चाहूंगा और आगे टॉम हेल द्वारा वर्णित किया गया हूं - मैं उनका जवाब विकसित करना चाहूंगा और कुछ कारण बताऊंगा कि यह बहुत अच्छा समाधान क्यों है:

• TeXify Readme2Tex ( ली उत्तर में उल्लेख ) का रैपर है । Readme2Tex का उपयोग करने के लिए आपको अपनी स्थानीय मशीन (अजगर, लेटेक्स, ...) में बहुत सारे सॉफ़्टवेयर स्थापित करने होंगे - लेकिन TeXify github प्लगइन है इसलिए आपको अपनी स्थानीय मशीन में कुछ भी स्थापित करने की आवश्यकता नहीं है - आपको केवल ऑनलाइन भुगतान करना होगा एक बटन दबाकर आप जीथब खाते में प्लग इन करें और रिपॉजिटरी चुनें जिसके लिए TeXify ने आपके टेक्स फॉर्मूलों को पार्स करने और चित्रों को जनरेट करने के लिए एक्सेस पढ़ा / लिखा होगा।
• जब आप अपनी रिपॉजिटरी में *.tex.mdफ़ाइल बनाते हैं या अपडेट करते हैं, तो TeXify परिवर्तनों का पता लगाएगा और *.mdफ़ाइल उत्पन्न करेगा जहां लेटेक्स फॉर्मूले texआपके रेपो में निर्देशिका में सहेजी गई तस्वीरों द्वारा बदले जाएंगे । इसलिए यदि आप README.tex.md फाइल बनाते हैं तो TeXify टेक्स फॉर्मूले के बजाय README.md को तस्वीरों के साथ जनरेट करेगा। तो टेक्स फ़ार्मुलों को पार्स करना और डॉक्यूमेंटेशन जनरेट करना प्रत्येक कमिट और पुश पर ऑटोमैटिकली किया जाता है :)
• क्योंकि आपके सभी फ़ार्मुलों को texडायरेक्टरी में चित्रों में बदल दिया गया है और README.md फ़ाइल उस चित्रों के लिंक का उपयोग करती है, आप TeXify को अनइंस्टॉल भी कर सकते हैं और आपके सभी पुराने दस्तावेज़ अभी भी काम करेंगे :)। texनिर्देशिका और *.tex.mdतो आप अपने मूल लेटेक्स सूत्रों और चित्रों (आप भी सुरक्षित रूप से में स्टोर कर सकते हैं के लिए उपयोग किया फ़ाइलों भंडार पर रहेंगे tex- TeXify उन्हें स्पर्श नहीं करेगा निर्देशिका अपने अन्य प्रलेखन चित्र "हाथ से बनाया")।
• आप README.tex.md फ़ाइल में सीधे लेटेक्स सिंटैक्स का उपयोग कर सकते हैं (बिना खोए .md मार्कडाउन सिंटैक्स) जो बहुत ही आसान है । Julii ने अपने उत्तर में बाहरी सेवा जैसे विशेष लिंक (सूत्रों के साथ) का उपयोग करने का प्रस्ताव दिया। http://latex.codecogs.com/gif.latex?s%3D%5Ctext%20%7B%20sensor%20reading%20%7Dजो अच्छा है, लेकिन कुछ कमियां हैं: लिंक में सूत्र पढ़ना और अपडेट करने के लिए आसान (आसान) नहीं हैं, और यदि उस तृतीय-पक्ष सेवा के साथ कुछ समस्या होगी तो आपका पुराना दस्तावेज़ काम करना बंद कर देगा ... TeXify में आपके पुराने दस्तावेज़ यदि आप उस प्लगइन को अनइंस्टॉल करते हैं तो भी हमेशा काम करेगा (क्योंकि लेटेक्स फॉर्मूले से उत्पन्न आपके सभी चित्र texडायरेक्टरी में रेपो में बने रहते हैं)।
• Yuchao जियांग अपने जवाब है, उपयोग करने के लिए प्रस्तावित में Jupyter नोटबुक जो भी अच्छा है, लेकिन som कमियां हैं: आप README.md फ़ाइल में सीधे सूत्रों का उपयोग नहीं कर सकते हैं, तो आप अन्य फाइल करने के लिए वहाँ कड़ी बनाने की जरूरत है * अपने रेपो में .ipynb लेटेक्स, इसमें शामिल हैं (मठजैक्स) सूत्र। फ़ाइल * .ipynb प्रारूप JSON है जिसे बनाए रखना आसान नहीं है (उदाहरण के लिए Gist * .ipynb फ़ाइल में लाइन नंबर के साथ विस्तृत त्रुटि नहीं दिखाता है, जब आप उचित स्थान पर अल्पविराम लगाना भूल जाते हैं ...)।

यहाँ मेरे कुछ रेपो से लिंक है जहाँ मैं TeXify का उपयोग करता हूँ जिसके लिए README.tex.md फ़ाइल से प्रलेखन उत्पन्न किया गया था ।

Comments

@ रोई मैं नहीं जानता

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

यह अच्छा है, लेकिन आप अप्रयुक्त कचरा svg छवियों के एक टन / टेक्स फ़ोल्डर में कैसे व्यवहार करते हैं?

— सर्ज पी।

@SergeP। सभी को धक्का और धक्का?

— कामिल Kiełczewski

Answer 7

GitHub पर पुश करने पर स्वचालित रूपांतरण के लिए, TeXify ऐप पर एक नज़र डालें :

GitHub App जो एक्सटेंशन * .tex.md के साथ फ़ाइलों के लिए आपके पुश में दिखता है और इसे SVX छवियों के रूप में TeX अभिव्यक्ति प्रदान करता है

यह कैसे काम करता है ( स्रोत भंडार से ):

जब भी आप धक्का देते हैं तो TeXify चलेगा और आपकी अंतिम प्रतिबद्ध में * .tex.md फ़ाइलों के लिए खोज करेगा। उनमें से प्रत्येक के लिए यह readme2tex चलाएगा जो डॉलर के संकेतों के बीच संलग्न LaTeX अभिव्यक्तियों को ले जाएगा, इसे सादे SVG छवियों में बदल देगा, और फिर आउटपुट को एक .md एक्सटेंशन फ़ाइल में सेव कर देगा (इसका मतलब है कि README .Net.md नाम की एक फ़ाइल। संसाधित किया जाएगा और आउटपुट को README.md के रूप में सहेजा जाएगा)। उसके बाद, आउटपुट फ़ाइल और नई एसवीजी छवियां फिर शुरू हो जाती हैं और आपके रेपो में वापस धकेल दी जाती हैं।

Comments

यह काम @agurodriguez द्वारा किया गया है जो ऊपर टिप्पणी में इसका उल्लेख करते हैं

— icc97

@ icc97 हां, लेकिन agurodriguez जवाब नहीं बनाते हैं (और मैं शायद उनकी टिप्पणी पर कभी गौर नहीं करूंगा)। क्योंकि टॉम उत्तर बनाते हैं (~ 1 वर्ष बाद एग्रोड्रोड्यूज़) मैं कहता हूं कि TeXify मौजूद है और यह मुझे TeXify का उपयोग करने और इस पर अपना उत्तर बेस लिखने की अनुमति देता है । तो यह अच्छा था :)

— कामिल कीलवस्की 12

@ KamilKiełczewski इस जवाब में कुछ भी गलत नहीं है, मैं सिर्फ उल्लेख कर रहा हूं कि TeXify को एक SO उपयोगकर्ता ने इस धागे के कारण बनाया था, जो बहुत अच्छा है।

— icc97

मैं अपने रीडमी पर TeXify का उपयोग कर रहा हूं, लेकिन किसी कारण से, प्रतिपादन लगभग हर बार जहां $...$पाठ में है, लाइनों को कूद रहा है । कोई सुराग क्यों? यह रेपो है: github.com/brunoconteleite/Spatial-Model-Solver

— Bruno Conte Leite

Answer 8

मेरा त्वरित समाधान यह है:

चरण 1. अपनी .mdफ़ाइल में लेटेक्स जोड़ें

$$x=\sqrt{2}$$

नोट: गणित eqns $ $ ... $$ या में होना चाहिए \\(... \\)।

चरण 2. अपनी scripts.htmlया थीम फ़ाइल में निम्न जोड़ें (इस कोड को अंत में जोड़ें)

<script type="text/javascript" async

src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-MML-AM_CHTML">

किया हुआ!। अपने eq देखें। पेज लोड करके।

Comments

कौन सी scripts.htmlफाइल? मैं इसे github फीचर के रूप में कोई संदर्भ नहीं दे सकता।

— जेई लेमोन

क्या आपके पास थीम फ़ाइल ( Jeykyllथीम फ़ाइल) है? यह कोड git पृष्ठों में लेटेक्स प्रदर्शित करने के लिए है।

— CKM

यह स्पष्ट करना चाहिए कि यह केवल git पृष्ठों के लिए काम करता है, नियमित रेपो में README.md के लिए नहीं।

— जर्मेनियम

Answer 9

आप लाटेक्स को रेंडर करने और जीथब को परिणाम देने के लिए एक निरंतर एकीकरण सेवा (जैसे ट्रैविस सीआई ) प्राप्त कर सकते हैं । सीआई प्रत्येक नई प्रतिबद्धता के बाद "क्लाउड" कार्यकर्ता को तैनात करेगा। कार्यकर्ता आपके दस्तावेज़ को पीडीएफ में संकलित करता है और या तो ImageMagick को एक छवि में बदलने के लिए कहता है या LaTeX-> HTML रूपांतरण का प्रयास करने के लिए पैनडॉक का उपयोग करता है जहां सफलता आपके दस्तावेज़ के आधार पर भिन्न हो सकती है। कार्यकर्ता तब आपकी रिपॉजिटरी में छवि या html भेजता है जहां से इसे आपके रीडमी में दिखाया जा सकता है।

नमूना ट्रैविसी कॉन्फिगरेशन जो एक पीडीएफ बनाता है, उसे एक पीएनजी में कनवर्ट करता है और यह बताता है कि आपके रेपो में स्थिर स्थान नीचे दिया गया है। आपको एक लाइन जोड़ने की आवश्यकता होगी जो एक इमेज में PDFconverts PDF लाती है

sudo: required
dist: trusty
os: linux
language: generic
services: docker
env:
  global:
  - GIT_NAME: Travis CI
  - GIT_EMAIL: [e-mail]
  - TRAVIS_REPO_SLUG: your-github-username/your-repo
  - GIT_BRANCH: master
# I recommend storing your GitHub Access token as a secret key in a Travis CI environment variable, for example $GH_TOKEN.
  - secure: ${GH_TOKEN}
script:
- wget https://raw.githubusercontent.com/blang/latex-docker/master/latexdockercmd.sh
- chmod +x latexdockercmd.sh
- "./latexdockercmd.sh latexmk -cd -f -interaction=batchmode -pdf yourdocument.tex -outdir=$TRAVIS_BUILD_DIR/"
- cd $TRAVIS_BUILD_DIR
- convert -density 300 -quality 90 yourdocument.pdf yourdocument.png
- git checkout --orphan $TRAVIS_BRANCH-pdf
- git rm -rf .
- git add -f yourdoc*.png
- git -c user.name='travis' -c user.email='travis' commit -m "updated PDF"
# note we are again using GitHub access key stored in the CI environment variable
- git push -q -f https://your-github-username:$[e-mail]/$TRAVIS_REPO_SLUG $TRAVIS_BRANCH-pdf
notifications:
  email: false

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

अधिक उदाहरणों के लिए इस github repo और इसके साथ sx चर्चा , PanDoc उदाहरण , https://dfm.io/posts/travis-latex/ और इस पोस्ट को मध्यम पर देखें ।

Answer 10

आप मार्कडाउन का उपयोग कर सकते हैं, जैसे

![equ](https://latex.codecogs.com/gif.latex?log(y)=\beta_0&space;+&space;\beta_1&space;x&space;+&space;u)

यहां कोड टाइप किया जा सकता है: https://www.codecogs.com/latex/eqneditor.php ।

Answer 11

यदि आप https://www.codecogs.com/latex/eqneditor.php के साथ समस्या कर रहे हैं , तो मैंने पाया कि https://alexanderrodin.com/github-latex-markdown/ ने मेरे लिए काम किया। यह आपको आवश्यक मार्कडाउन कोड बनाता है, इसलिए आप इसे अपने README.md दस्तावेज़ में काटें और पेस्ट करें।