2016-02-19 22 views
26

Czy istnieje sposób renderowania LaTexa w pliku README.md w repozytorium GitHub? Przeszukałem go i przeszukano przepełnienie stosu, ale żadna z powiązanych odpowiedzi nie wydaje się możliwa.Renderowanie latexowe w README.md na Githubie

+1

Nie jest to możliwe bezpośrednio. Czy jest jakaś szczególna rzecz, dla której potrzebujesz LaTex? Na przykład, jeśli chcesz równania matematycznego, może to być wykonalne z pewnymi sztuczkami. Powiedz nam, co chcesz renderować, a ktoś może wskazać ci obejście problemu. – Waylan

+0

Tak, chcę mieć równania matematyczne i wyrównane równania, wraz z wstawionymi symbolami matematycznymi. To prawie wszystko. – user90593

+0

Zobacz ten związany post: [Jak wyświetlić równania matematyczne w ogólnym obniżeniu githuba (nie blog githuba)] (http://stackoverflow.com/a/11256862/866026). – Waylan

Odpowiedz

6

Readme2Tex

pracuję nad scenariuszem, który automatyzuje większość cruft z coraz LaTeX przygotowana ładnie do Github smaku Markdown: https://github.com/leegao/readme2tex

Istnieje kilka wyzwań z wyprawą LaTeX dla Github . Po pierwsze, Markdown o smaku Githuba usuwa większość znaczników i większość atrybutów. Oznacza to brak bibliotek opartych na JavaScript (takich jak Mathjax) ani żadnych stylów CSS.

Naturalnym rozwiązaniem wydaje się być osadzanie obrazów prekompilowanych równań. Wkrótce jednak uświadomisz sobie, że LaTeX nie tylko zamienia załączone wzory na znaki dolara w obrazy.

enter image description here

Wystarczy osadzanie zdjęć z kompilatorów internetowych daje to bardzo nienaturalny wygląd dokumentu. W rzeczywistości twierdzę, że jest on jeszcze bardziej czytelny w twoim codziennym slangu matematycznym x^2 niż w skoku .

Uważam, że ważne jest, aby upewnić się, że dokumenty są składane w sposób naturalny i czytelny. Dlatego napisałem scenariusz, który poza kompilacją formuł do obrazów zapewnia również, że wynikowy obraz jest odpowiednio dopasowany i wyrównany do reszty tekstu.

Na przykład, oto fragment z pliku .md dotyczące niektórych enumeratywnej właściwości wyrażeń regularnych przygotowana przy użyciu readme2tex:

enter image description here

Jak można się spodziewać, zestaw równań na górze jest określona przez dopiero zaczyna odpowiedni align* środowiska

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

Zauważ, że podczas równania inline ($ ... $) prowadzony z tekstem, wystawiania e kwantyfikatory (te rozdzielone przez \begin{ENV}...\end{ENV} lub $$...$$) są wyśrodkowane. Ułatwia to ludziom, którzy już są przyzwyczajeni do LaTeX, aby zachować produktywność.

Jeśli to brzmi jak coś, co może pomóc, sprawdź to. https://github.com/leegao/readme2tex

+3

Na podstawie tych prac utworzyłem aplikację GitHub, która automatyzuje proces renderowania, uruchamiając go za każdym razem, gdy zostanie naciśnięty. Myślę, że jest to przydatne, więc udostępniam link tym, którzy chcą spróbować: https://github.com/agurz/github-texify – agurz

+2

Nice! To naprawdę świetna robota :) – Lee

1

Można również skorzystać z tego edytora online: https://www.codecogs.com/latex/eqneditor.php, który generuje pliki SVG w locie. Możesz umieścić link w swoim dokumencie: ![](https://latex.codecogs.com/svg.latex?y%3Dx%5E2), co daje w wyniku: .

7

Dla krótkich ekspresji i nie tak wyszukanej matematyki można użyć wbudowanego kodu HTML, aby uzyskać lateks renderujący matematykę na kodekach, a następnie osadzić wynikowy obraz.Oto przykład:

- <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 " /> 

co powinno skutkować w coś następnego

UPDATE: To działa świetnie w Eclipse, ale nie w github niestety . Jedyna praca do wykonania to następna:

Weź swoje równanie lateksu i przejdź do http://www.codecogs.com/latex/eqneditor.php, w dolnej części obszaru, w którym pojawi się twoje równanie, pojawi się maleńkie menu rozwijane, wybierz zakodowany URL, a następnie wklej to w swoim przecinku github w następujący sposób:

![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) 
Powiązane problemy