Latex rendu dans le fichier README.md sur Github

Est-il un moyen de rendre LaTex dans le README.md dans un dépôt GitHub? J'ai cherché et cherché sur stack overflow, mais aucune des réponses semble faisable.

Il n'est pas possible directement. Est-il une chose spécifique que vous pensez que vous avez besoin de LaTex pour? Par exemple, si vous voulez équations mathématiques, qui peut être faisable avec quelques astuces spécifiques. Dites-nous ce que vous voulez le rendre, et quelqu'un pourrait être en mesure de vous à une solution de contournement.
Oui je veux équations mathématiques et alignés sur les équations, avec inline symboles mathématiques. C'est assez bien.
Voir ce post: Comment afficher des équations mathématiques en général github du markdown(pas de github blog).
Aussi ceci: LaTeX mathématiques dans github wikis.
Aussi stackoverflow.com/questions/48511527/...
Il suffit d'aller pour GitHub Pages. Je suis d'étudier sérieusement les asciidcotor + serveur-rendu Katex: github.com/asciidoctor/asciidoctor/pull/3338 comme l'ultime Nirvana maintenant.
avez-vous envisagé d'utiliser Jupyter carnets? Vous pouvez même insérer du code python maintenant 😉

InformationsquelleAutor user90593 | 2016-02-19

25

Pour de courtes expressions et pas tellement envie de mathématiques, vous pouvez utiliser le inline HTML pour obtenir votre latex rendu de maths sur codecogs et puis d'intégrer l'image résultante. Voici un exemple:
```
- <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 " />
```
Qui devrait se traduire par quelque chose comme la prochaine

$Latex rendu dans le fichier README.md sur Github$

$Latex rendu dans le fichier README.md sur Github$

$Latex rendu dans le fichier README.md sur Github$

Mise à jour: Cela fonctionne très bien dans eclipse, mais pas dans github malheureusement. Le seul travail est environ la suivante:

Prendre votre latex équation et aller à http://www.codecogs.com/latex/eqneditor.php, au bas de la zone où votre équation apparaît affiché il y a un petit menu déroulant, choisissez codées dans l'URL et collez-la dans votre github démarque par le moyen suivant:
```
![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)
```
- Je vous conseille d'utiliser latex.codecogs.com/png.latex au lieu de latex.codecogs.com/gif.latex; elle renvoie une meilleure qualité d'image!
- vous pouvez utiliser latex.codecogs.com/svg.latex il est indépendant de la résolution.
InformationsquelleAutor Juli
16

Readme2Tex

J'ai travaillé sur un script qui automatise la plupart des trucs de prise en LaTeX typeset bien dans Github à saveur de markdown: https://github.com/leegao/readme2tex

Il y a un peu de problèmes avec le rendu LaTeX pour Github. Tout d'abord, Github saveur démarque des bandes de la plupart des balises et les attributs. Cela signifie pas de Javascript basé sur les bibliothèques (comme Mathjax) ni le style CSS.

La solution la plus évidente semble être d'intégrer des images de précompilés équations. Cependant, vous vous rendrez vite compte que le LaTeX ne se contente pas de tourner en dollars signe clos de formules en images.

Simplement intégrer des images en ligne, des compilateurs donne ce vraiment anormal look à votre document. En fait, je dirais que c'est même plus lisible dans le quotidien de la x^2 mathématique de l'argot que jumpy .

Je crois que faire en sorte que vos documents sont affichés dans un cadre naturel et lisible est important. C'est pourquoi j'ai écrit un script qui, au-delà de compilation de formules en images, s'assure également que l'image est correctement monté et aligné sur le reste du texte.

Par exemple, voici un extrait d'un .md fichier concernant certains énumérative propriétés des expressions régulières en page à l'aide de readme2tex:

Comme vous vous en doutez, l'ensemble des équations du haut est spécifié par juste de commencer le correspondant align* environnement
```
**Theorem**: The translation $[\![e]\!]$ given by
\begin{align*}
...
\end{align*}
...
```
Avis que si inline équations ($...$) exécuter avec le texte, les équations d'écran (ceux qui sont délimitées par \begin{ENV}...\end{ENV} ou $$...$$) sont centrés. Cela rend plus facile pour les gens qui sont déjà habitués à LaTeX de continuer à être productifs.

Si cela sonne comme quelque chose qui pourrait aider, assurez-vous de le vérifier. https://github.com/leegao/readme2tex
- Sur base de ce travail, j'ai créé un GitHub application qui automatise le processus de rendu, déclenchant à chaque fois un push, c'est fait. Je pense que c'est utile je partage donc le lien pour ceux qui veulent essayer: github.com/agurz/github-texify
- Nice! C'est vraiment génial de vous faire 🙂
- Le TeXify Application ne semble pas fonctionner lorsque y compris inline mathjax pour markdown éléments énumérés.
InformationsquelleAutor Lee
13

Mon astuce est d'utiliser le Jupyter Portable.

GitHub a un support intégré pour le rendu .ipynb fichiers. Vous pouvez écrire en ligne et l'affichage du code LaTeX dans le carnet de notes et GitHub rendra pour vous.

Voici un exemple de fichier notebook: https://gist.github.com/cyhsutw/d5983d166fb70ff651f027b2aa56ee4e
- génial comme idée!! Maintenant, je peux même utiliser le code python!
InformationsquelleAutor Yuchao Jiang
10

On peut également utiliser cet éditeur en ligne: https://www.codecogs.com/latex/eqneditor.php qui génère SVG des fichiers à la volée. Vous pouvez mettre un lien dans votre document comme ceci:
![](https://latex.codecogs.com/svg.latex?y%3Dx%5E2) qui se traduit par:
$Latex rendu dans le fichier README.md sur Github$ .

InformationsquelleAutor Dylan Richard Muir
9

- Je télécharger des référentiels avec les équations de Gitlab, car il a un support natif pour LaTeX .md fichiers:
```
```math
SE = \frac{\sigma}{\sqrt{n}}
```
```
La syntaxe en ligne de latex est $`\sqrt{2}`$.

Gitlab rend les équations avec du JavaScript dans le navigateur au lieu de montrer des images, ce qui améliore la qualité des équations.

Plus d'infos ici.

Espérons Github mettra en œuvre le présent comme dans l'avenir.
- Incroyable! Merci pour l'astuce 🙂
InformationsquelleAutor Evgenii
5

J'ai tester la solution proposée par les autres et je tiens à recommander TeXify créé et proposé en commentaire par agurodriguez et par Tom Hale - je voudrais développer sa réponse et de donner quelques raisons pour lesquelles c'est une très bonne solution:
- TeXify est wrapper de Readme2Tex (mention dans Lee répondre). Pour utiliser Readme2Tex vous devez installer beaucoup de logiciels dans votre ordinateur local (python, latex, ...) - mais TeXify est github plugin vous n'avez pas besoin d'installer quoi que ce soit dans votre machine locale - vous ne devez en ligne l'installation de ce plugin en vous github compte en appuyant sur l'un bouton et choisir des référentiels pour qui TeXify aura accès en lecture/écriture pour analyser votre tex formules et de produire des images.
- Lors de votre dépôt de la création ou de mise à jour *.tex.md fichier, la TeXify permettra de détecter les changements et générer *.md fichier latex formules seront échangés par ses photos enregistrées dans tex répertoire dans votre pension. Donc, si vous créez README.tex.md fichier puis TeXify va générer README.md avec des photos plutôt tex formules. Donc l'analyse tex formules et de générer de la documentation se fait automatiquement sur chaque commit&pousser 🙂
- Parce que toutes vos formules sont transformées en images dans tex répertoire et le fichier LISEZMOI.md fichier utilisez des liens pour que les photos, vous pouvez même désinstaller TeXify et l'ensemble de vos documents fonctionnera toujours :). Le tex répertoire et *.tex.md les fichiers vont rester sur le référentiel de sorte que vous avez accès à votre original latex formules et des images (vous pouvez également stocker en toute sécurité dans tex répertoire de vos autres documents images "par la main" - TeXify n'y touchent pas).
- Vous pouvez utiliser les équations syntaxe latex directement dans le fichier README.tex.md fichier (sans perdre .rapport de la syntaxe markdown) ce qui est très pratique. Julii dans sa réponse proposé d'utiliser des liens spéciaux (avec formules) au service externe e.g . http://latex.codecogs.com/gif.latex?s%3D%5Ctext%20%7B%20sensor%20reading%20%7D qui est bon a cependant quelques inconvénients: les formules dans les liens ne sont pas facile (pratique) pour lire et mettre à jour, et si il y a des problème avec cette tierce-partie de service de votre ancien documentation d'arrêt de travail... Dans TeXify votre ancien documentation fonctionne toujours, même si vous désinstallez le plugin (parce que toutes vos images générées à partir de latex formules de séjour en repo dans tex répertoire).
- La Yuchao Jiang, dans sa réponse, a proposé d'utiliser Jupyter Portable qui est aussi agréable cependant som inconvénients: vous ne pouvez pas utiliser des formules directement dans le fichier README.md fichier, vous avez besoin pour faire de lien vers un autre fichier *.ipynb dans votre pension qui contient du latex (MathJax) les formules. Le fichier *.ipynb format JSON qui n'est pas très pratique à entretenir (par exemple, Gist ne pas afficher d'erreur détaillé avec le numéro de ligne dans *.ipynb fichier lorsque vous avez oublié de mettre une virgule au bon endroit...).
Voici le lien à certains de mes pensions où j'utilise TeXify dont la documentation a été généré à partir README.tex.md fichier.
- Est-il quelque chose comme NBViewer pour les fichiers MarkDown? À savoir un service que vous lui donnez une URL de fichier MarkDown et il va montrer de sortie avec MathJax de Soutien? Il y a beaucoup d'éditeurs, mais je ne pouvais pas trouver spectateur.
- Je ne sais pas
- Il est joli, mais comment faire face à une tonnes de déchets inutilisés svg images dans le dossier /tex?
- supprimer tout et de pousser?
InformationsquelleAutor Kamil Kiełczewski
4

Pour la conversion automatique à pousser à GitHub, jetez un oeil à la TeXify application:

GitHub Application qui ressemble à votre pousse de fichiers avec l'extension *.tex.md et le rend TeX expressions comme des images SVG

Comment il fonctionne (à partir de la référentiel source):

Chaque fois que vous appuyez TeXify va fonctionner et de recherche pour *.tex.md fichiers dans votre dernier commit. Pour chacun de ceux qu'il va fonctionner readme2tex qui prendra en LaTeX expressions enfermé entre des signes dollar, de les convertir en plaine images SVG, puis enregistrer la sortie dans un .rapport de l'extension de fichier (ce Qui signifie qu'un fichier nommé README.tex.md sera traitée et le résultat sera enregistré en tant que fichier README.md). Après cela, le fichier de sortie et le nouveau SVG images sont ensuite ajoutés et repoussé à votre repo.
- Ce travail est par @agurodriguez qui la mentionne dans un comment ci-dessus
- oui, mais agurodriguez créez pas de réponse (et je ne sera probablement jamais l'avis de son commentaire). Parce que Tom créer de réponse (~1 an après agurodriguez) j'ai remarquer que TeXify existe et il me permet d'utiliser TeXify et d'écrire ma propre répondre sur cette base. Il était donc bon 🙂
- Il n'y a rien de mal avec cette réponse, je suis juste de mentionner que TeXify a été créé par un utilisateur en raison de ce fil de discussion, ce qui est plutôt cool.
InformationsquelleAutor Tom Hale

Vous devez vous connecter pour publier un commentaire.

Readme2Tex