online - Representación de látex en README.md en Github

readme md formatting github

Question

¿Hay alguna forma de representar LaTex en README.md en un repositorio de GitHub? Lo busqué en Google y busqué en el desbordamiento de pila, pero ninguna de las respuestas relacionadas parece factible.

Answer 1

Léame2Tex

He estado trabajando en una secuencia de comandos que automatiza la mayor parte de la simplificación de la composición tipográfica de LaTeX en la rebaja con sabor a Github: https://github.com/leegao/readme2tex

Hay algunos desafíos con la representación de LaTeX para Github. Primero, el descuento con sabor a Github elimina la mayoría de las etiquetas y la mayoría de los atributos. Esto significa que no hay bibliotecas basadas en Javascript (como Mathjax) ni ningún estilo CSS.

La solución natural parece ser incrustar imágenes de ecuaciones precompiladas. Sin embargo, pronto se dará cuenta de que LaTeX hace más que simplemente convertir las fórmulas incluidas en el signo de dólar en imágenes.

Simplemente incrustar imágenes de compiladores en línea le da a este documento un aspecto realmente antinatural. De hecho, diría que es aún más legible en tu jerga matemática x ^ 2 cotidiana que jumpy .

Creo que es importante asegurarse de que sus documentos estén escritos de forma natural y legible. Es por eso que escribí un script que, más allá de compilar fórmulas en imágenes, también asegura que la imagen resultante se ajuste y alinee correctamente con el resto del texto.

Por ejemplo, aquí hay un extracto de un archivo .md respecto a algunas propiedades enumerativas de las expresiones regulares compuestas con readme2tex :

Como es de esperar, el conjunto de ecuaciones en la parte superior se especifica simplemente iniciando el entorno de align* correspondiente

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

Observe que mientras las ecuaciones en línea ($ ... $) se ejecutan con el texto, las ecuaciones de visualización (aquellas que están delimitadas por /begin{ENV}.../end{ENV} o $$...$$ ) están centradas. Esto facilita que las personas que ya están acostumbradas a LaTeX sigan siendo productivas.

Si esto suena como algo que podría ayudar, asegúrese de verificarlo. https://github.com/leegao/readme2tex

Answer 2

Mi solución rápida es esta:

paso 1. Agrega latex a tu archivo .md

$$x=/sqrt{2}$$

Nota: las ecuaciones matemáticas deben estar en $$ ... $$ o //(... //) .

paso 2. Agregue lo siguiente a su archivo scripts.html o tema (agregue este código al final)

<script type="text/javascript" async src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-MML-AM_CHTML">

¡Hecho!. Ver tu eq. cargando la página.

Answer 3

Mi truco es usar el cuaderno Jupyter.

GitHub tiene soporte incorporado para renderizar archivos .ipynb. Puede escribir en línea y mostrar el código LaTeX en el cuaderno y GitHub lo renderizará por usted.

Aquí hay un archivo de cuaderno de muestra: https://gist.github.com/cyhsutw/d5983d166fb70ff651f027b2aa56ee4e

Answer 4

Para expresiones cortas y matemáticas no tan sofisticadas, puede usar el HTML en línea para obtener sus matemáticas de látex en codecogs y luego incrustar la imagen resultante. Aquí un ejemplo:

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

Lo que debería resultar en algo así como el próximo

Actualización: Esto funciona muy bien en eclipse pero desafortunadamente no en github. La única solución es la siguiente:

Tome su ecuación de látex y vaya a http://www.codecogs.com/latex/eqneditor.php , en la parte inferior del área donde aparece su ecuación se muestra un pequeño menú desplegable, elija la URL codificada y luego péguela en su Github Markdown de la siguiente manera:

![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)

Answer 5

Para la conversión automática al empujar a GitHub, eche un vistazo a la aplicación TeXify :

Aplicación GitHub que busca archivos con extensión * .tex.md y muestra sus expresiones TeX como imágenes SVG

Cómo funciona (desde el repositorio de origen ):

Cada vez que presione TeXify se ejecutará y buscará archivos * .tex.md en su última confirmación. Para cada uno de ellos, ejecutará readme2tex, que tomará expresiones LaTeX encerradas entre signos de dólar, lo convertirá en imágenes SVG simples y luego guardará la salida en un archivo de extensión .md (Eso significa que un archivo llamado README.tex.md se procesará y la salida se guardará como README.md). Después de eso, el archivo de salida y las nuevas imágenes SVG se confirman y se devuelven a su repositorio.

Answer 6

Subo repositorios con ecuaciones a Gitlab porque tiene soporte nativo para LaTeX en archivos .md:

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

La sintaxis para el látex en línea es $`/sqrt{2}`$ .

Gitlab renderiza ecuaciones con JavaScript en el navegador en lugar de mostrar imágenes, lo que mejora la calidad de las ecuaciones.

Más información here .

Esperemos que Github implemente esto también en el futuro.

Answer 7

También se puede usar este editor en línea: https://www.codecogs.com/latex/eqneditor.php que genera archivos SVG sobre la marcha. Puede poner un enlace en su documento como este ![](https://latex.codecogs.com/svg.latex?y%3Dx%5E2) que da como resultado: .

Answer 8

TeXify alguna solución propuesta por otros y me gustaría recomendar TeXify creado y propuesto en comentario por agurodriguez y más descrito por Tom Hale . Me gustaría desarrollar su respuesta y dar alguna razón por la cual esta es una muy buena solución:

• TeXify es el contenedor de https://github.com/leegao/readme2tex (mención en la respuesta de Lee ). Para usar Readme2Tex, debe instalar una gran cantidad de software en su máquina local (python, latex, ...), pero TeXify es un complemento de github, por lo que no necesita instalar nada en su máquina local , solo necesita una instalación en línea que conecte su cuenta github presionando un TeXify y elija repositorios para los cuales TeXify tendrá acceso de lectura / escritura para analizar sus fórmulas de texto y generar imágenes.
• Cuando en su repositorio cree o actualice el archivo *.tex.md , TeXify detectará los cambios y generará el archivo *.md donde las fórmulas de látex se intercambiarán por sus imágenes guardadas en el directorio tex en su repositorio. Entonces, si crea el archivo README.tex.md, TeXify generará README.md con imágenes en lugar de fórmulas tex. Por lo tanto, el análisis de fórmulas de texto y la generación de documentación se realiza automáticamente en cada confirmación y envío :)
• Debido a que todas sus fórmulas se cambian a imágenes en el directorio tex y el archivo README.md usa enlaces a esas imágenes, incluso puede desinstalar TeXify y toda su documentación anterior seguirá funcionando :). El directorio tex y los archivos *.tex.md permanecerán en el repositorio para que tenga acceso a sus fórmulas e imágenes originales de látex (también puede almacenar de forma segura en el directorio tex sus otras imágenes de documentación "hechas a mano" - TeXify no las tocará) .
• Puede usar la sintaxis de látex de ecuaciones directamente en el archivo README.tex.md (sin perder la sintaxis de marcado .md) que es muy útil . Julii en su respuesta propuso utilizar enlaces especiales (con fórmulas) a servicios externos, por ejemplo. http://latex.codecogs.com/gif.latex?s%3D%5Ctext%20%7B%20sensor%20reading%20%7D que es bueno, sin embargo, tiene algunos inconvenientes: las fórmulas en los enlaces no son fáciles (útiles) para lea y actualice, y si habrá algún problema con ese servicio de terceros, su documentación anterior dejará de funcionar ... En TeXify, su documentación anterior siempre funcionará incluso si desinstala ese complemento (porque todas sus imágenes generadas a partir de fórmulas de látex son permanecer en repositorio en el directorio tex ).
• El Yuchao Jiang en su respuesta, propuso usar https://gist.github.com/cyhsutw/d5983d166fb70ff651f027b2aa56ee4e que también es bueno, pero tiene algunos inconvenientes: no puede usar fórmulas directamente en el archivo README.md, debe hacer un enlace allí a otro archivo * .ipynb en su repositorio que contiene látex (MathJax) fórmulas. El formato de archivo * .ipynb es JSON, lo cual no es útil de mantener (por ejemplo, Gist no muestra un error detallado con el número de línea en el archivo * .ipynb cuando olvidó poner la coma en el lugar correcto ...).

Aquí hay un enlace a algunos de mis repositorios donde uso TeXify para el cual se generó documentación del archivo README.tex.md .