Rendu au latex dans README.md sur Github
Est-il possible de rendre LaTex dans README.md dans un référentiel GitHub? Je l'ai googlé et cherché sur le débordement de pile mais aucune des réponses liées ne semble faisable.
Pour les expressions courtes et les calculs peu sophistiqués, vous pouvez utiliser le code HTML en ligne pour obtenir vos calculs en latex sur des codecogs, puis 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 " />
Ce qui devrait donner quelque chose comme le prochain
Mise à jour: Cela fonctionne très bien dans Eclipse mais pas dans github malheureusement. Le seul travail autour est le suivant:
Prenez votre équation au latex et allez à http://www.codecogs.com/latex/eqneditor.php , au bas de la zone où votre équation apparaît, un petit menu déroulant s'affiche, choisissez une URL encodée, puis collez cela dans votre démarque github de la manière suivante:
Readme2Tex
Je travaille sur un script qui automatise la majeure partie du processus consistant à bien composer LaTeX dans le démarquage Github: https://github.com/leegao/readme2tex
Le rendu de LaTeX pour Github pose quelques problèmes. Tout d’abord, le démarquage à saveur Github enlève la plupart des balises et des attributs. Cela signifie qu'aucune bibliothèque basée sur Javascript (comme Mathjax) ni aucun style CSS.
La solution naturelle semble alors être d’incorporer des images d’équations précompilées. Cependant, vous vous rendrez vite compte que LaTeX fait plus que transformer des formules fermées signées dollar en images.
Intégrer simplement des images provenant de compilateurs en ligne confère à votre document une apparence vraiment non naturelle. En fait, je dirais que c'est encore plus lisible dans votre argot mathématique quotidien que ^ nerveux 
.
Je pense qu'il est important de s'assurer que vos documents sont dactylographiés de manière naturelle et lisible. C'est pourquoi j'ai écrit un script qui, au-delà de la compilation de formules en images, garantit également que l'image résultante est correctement ajustée et alignée sur le reste du texte.
Par exemple, voici un extrait d'un fichier .md concernant certaines propriétés énumératives d'expressions régulières composées à l'aide de readme2tex:
Comme on pouvait s'y attendre, l'ensemble des équations en haut est spécifié en démarrant simplement l'environnement align* correspondant.
**Theorem**: The translation $[\![e]\!]$ given by
\begin{align*}
...
\end{align*}
...
Notez que pendant que les équations en ligne ($ ... $) sont exécutées avec le texte, les équations affichées (celles délimitées par \begin{ENV}...\end{ENV} ou $$...$$) sont centrées. Cela permet aux personnes déjà habituées à LaTeX de rester productives.
Si cela ressemble à quelque chose qui pourrait aider, assurez-vous de vérifier. https://github.com/leegao/readme2tex
Mon astuce consiste à utiliser le Jupyter Notebook.
GitHub a un support intégré pour le rendu des fichiers .ipynb. Vous pouvez écrire en ligne et afficher le code LaTeX dans le cahier et GitHub le restituera pour vous.
Voici un exemple de fichier de bloc-notes: https://Gist.github.com/cyhsutw/d5983d166fb70ff651f027b2aa56ee4e
Pour la conversion automatique lors du transfert vers GitHub, jetez un coup d’œil à TeXify app:
GitHub App qui cherche dans vos pushs les fichiers avec l'extension * .tex.md et restitue ses expressions TeX sous forme d'images SVG
Comment ça marche (depuis le répertoire source ):
Chaque fois que vous poussez, TeXify s'exécutera et recherchera les fichiers * .tex.md dans votre dernier commit. Readme2tex utilise des expressions LaTeX délimitées par des signes dollar, le convertit en images SVG standard, puis enregistre la sortie dans un fichier d'extension .md (Cela signifie qu'un fichier nommé README.tex.md sera traité et le résultat sera enregistré sous le nom README.md). Après cela, le fichier de sortie et les nouvelles images SVG sont ensuite validés et transférés dans votre référentiel.
On peut également utiliser cet éditeur en ligne: https://www.codecogs.com/latex/eqneditor.php qui génère des fichiers SVG à la volée. Vous pouvez mettre un lien dans votre document comme ceci:  qui résulte en: .
Je télécharge des référentiels avec des équations vers Gitlab car il dispose d'un support natif pour LaTeX dans les fichiers .md:
```math
SE = \frac{\sigma}{\sqrt{n}}
```
La syntaxe pour le latex en ligne est $`\sqrt{2}`$.
Gitlab affiche les équations avec JavaScript dans le navigateur au lieu d'afficher des images, ce qui améliore la qualité des équations.
Plus d'infos ici .
Espérons que Github l'implémentera également à l'avenir.