Gibt es eine Möglichkeit, LaTex in README.md in einem GitHub-Repository zu rendern? Ich habe es gegoogelt und auf Stack-Überlauf gesucht, aber keine der zugehörigen Antworten scheint machbar.Latex-Rendering in README.md auf Github
Antwort
Readme2Tex
Ich habe an einem Drehbuch arbeiten, die aus immer LaTeX gut in Github Geschmack Abschlags setzen die meisten der cruft automatisiert: https://github.com/leegao/readme2tex
Es gibt einige Herausforderungen mit LaTeX-Rendering für Github . Erstens, Github-Geschmack Markdown Streifen die meisten Tags und die meisten Attribute. Dies bedeutet keine Javascript-basierten Bibliotheken (wie Mathjax) noch CSS-Styling.
Die natürliche Lösung scheint dann zu sein, Bilder von vorkompilierten Gleichungen einzubetten. Sie werden jedoch bald feststellen, dass LaTeX mehr tut, als nur die eingeschlossenen Dollar-Zeichen-Formeln in Bilder umzuwandeln.
einfach Bilder von Online-Compiler Einbettung gibt dieses wirklich unnatürliches Aussehen zu Ihrem Dokument. In der Tat würde ich argumentieren, dass es in Ihrem täglichen x^2 mathematischen Slang als jumpy noch lesbarer ist.
Ich glaube, dass es wichtig ist sicherzustellen, dass Ihre Dokumente auf natürliche und lesbare Weise gesetzt werden. Aus diesem Grund habe ich ein Skript geschrieben, das über das Zusammenstellen von Formeln in Bilder hinaus auch sicherstellt, dass das resultierende Bild richtig angepasst und an den Rest des Textes angepasst wird.
Zum Beispiel, hier ist ein Auszug aus einer .md
Datei einige enumerative Eigenschaften von regulären Ausdrücken in Bezug auf typeset readme2tex
mit:
Wie zu erwarten, wird der Satz von Gleichungen an der Spitze angegeben durch nur Starten der entsprechenden align*
Umgebung
**Theorem**: The translation $[\![e]\!]$ given by
\begin{align*}
...
\end{align*}
...
Beachten Sie, dass während Inline-Gleichungen ($ ... $) laufen mit dem Text, Anzeige e Anfragen (die durch \begin{ENV}...\end{ENV}
oder $$...$$
abgegrenzt sind) sind zentriert. Dies macht es für LaTeX-Benutzer einfach, produktiv zu bleiben.
Wenn das klingt wie etwas, das helfen könnte, stellen Sie sicher, es zu überprüfen. https://github.com/leegao/readme2tex
Basierend auf dieser Arbeit habe ich eine GitHub-App erstellt, die den Rendering-Prozess automatisiert und ihn jedes Mal auslöst, wenn ein Push gemacht wird. Ich denke, es ist nützlich, also teile ich den Link für diejenigen, die es ausprobieren möchten: https://github.com/agurz/github-texify – agurz
Nizza! Das ist wirklich toll von dir :) – Lee
Man kann auch diesen Online-Editor verwenden: https://www.codecogs.com/latex/eqneditor.php, der SVG
Dateien im laufenden Betrieb erzeugt. Sie können einen Link in Ihr Dokument wie folgt einfügen: ![](https://latex.codecogs.com/svg.latex?y%3Dx%5E2)
was ergibt: .
Für kurze Ausdrücke und nicht so ausgefallene Mathematik könnten Sie die Inline-HTML verwenden, um Ihre Latex-Mathe auf Codecogs zu bekommen und dann das resultierende Bild einzubetten.Hier ein Beispiel:
- <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 " />
, die in so etwas wie die nächsten
-Update führen sollen: Dies funktioniert gut in Eclipse aber nicht in Github leider . Die einzige Arbeit ist die nächste:
Nehmen Sie Ihre Latex-Gleichung und gehen Sie zu http://www.codecogs.com/latex/eqneditor.php, am unteren Rand des Bereichs, in dem Ihre Gleichung angezeigt wird, gibt es ein kleines Dropdown-Menü, URL-codiert auswählen und fügen Sie das in Ihrem Github Markdown auf die nächste Art:
![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)
- 1. Ein gif auf einer README.md auf github
- 2. Lesezeichen in GitHub einbetten README.md
- 3. JavaScript in GitHub einbinden README.md
- 4. Linking mit relativer Pfad auf Github README.md
- 5. Zeige github build status in readme.md
- 6. Wie HTML-Inhalt in github README.md anzeigen?
- 7. Github enthalten MD-Dateien in README.md?
- 8. Abschriften zu HTML von GitHub README.md Datei
- 9. Wie wird Github Flavored Markdown in README.md-Datei standardmäßig verwendet?
- 10. show license.md in github Online-Verzeichnis wie README.md
- 11. Verwenden Sie Autotools mit README.md
- 12. Wie kann ich Zweige auf Github zusammenführen
- 13. Neue Linien innerhalb Absatz in README.md
- 14. Wie füge ich ohloh.net-Widgets zu meiner github-Projekte readme.md-Datei hinzu?
- 15. webpack + octicons: Wie man "main": "readme.md" in package.json behandelt/ignoriert
- 16. Benutzerdefinierte Schriftarten in Githubs Markdown (wie README.md)?
- 17. Wie kann ich eine README.md-Datei mit Xcode hinzufügen?
- 18. Neue R-Paketentwicklung auf GitHub starten
- 19. Warum folgt der Browser nicht einer HTTP 302-Weiterleitung für eine Bildressource auf einer gerenderten GitHub README.md?
- 20. Wie lies ich readme.md oben auf der Seite
- 21. Link zu einer Zeile Markdown-Datei auf GitHub
- 22. Wie automatisch erstellt README.md Markdown der Verzeichnisbaum Auflistung
- 23. Durchstreichen in einer reStructuredText-Datei, die auf GitHub gehostet wird?
- 24. Bilder in Markdown-Dateien in GitHub Enterprise
- 25. Visualize Zweige auf GitHub
- 26. Was macht die README.md-Datei in Git Repo?
- 27. Abschriften interne Links nicht in BitBucket Arbeits README.md
- 28. GitHub Wiki Zweig auswählen, der auf GitHub angezeigt wird
- 29. Github readme Bild bettet in privaten Repo?
- 30. Konfiguration für GitHub Zweig Beschränkungen nicht auf GitHub Website
Es ist nicht direkt möglich. Gibt es eine bestimmte Sache, für die Sie LaTex brauchen? Zum Beispiel, wenn Sie mathematische Gleichungen wollen, kann das mit einigen spezifischen Tricks machbar sein. Teilen Sie uns mit, was Sie rendern möchten, und jemand könnte Sie möglicherweise auf eine Problemumgehung hinweisen. – Waylan
Ja Ich möchte mathematische Gleichungen und ausgerichtete Gleichungen zusammen mit mathematischen Inline-Symbolen. Das wars so ziemlich. – user90593
Sehen Sie diesen verwandten Pfosten: [Wie man mathematische Gleichungen im allgemeinen githubs Abschlag zeigt (nicht Githubs Blog)] (http://stackoverflow.com/a/11256862/866026). – Waylan