Skip to content

Instantly share code, notes, and snippets.

@mrcodedev
Last active August 18, 2023 12:06
Show Gist options
  • Save mrcodedev/9256b5e9f9f9074ba7dff7a4de81964f to your computer and use it in GitHub Desktop.
Save mrcodedev/9256b5e9f9f9074ba7dff7a4de81964f to your computer and use it in GitHub Desktop.
Como usar markdown para documentar en GitHub

Encabezados

# H1
## H2
### H3
#### H4
##### H5
###### H6

Alternativamente, para H1 y H2, un estilo de subrayado:

Alt-H1
======

Alt-H2
------

H1

H2

H3

H4

H5
H6

Alternativamente, para H1 y H2, un estilo de subrayado:

Alt-H1

Alt-H2

Énfasis

Énfasis, conocido con itálica, con *asteriscos* o _barrabaja_.

Énfasis fuerte, conocido como negrita, con **arsteriscos** o __barrasbajas__.

Énfasis combinado con **asteriscos o _barrabaja_**

Para usar tachado se usa dos tíldes. ~~Tacha esto.~~

Énfasis, conocido con itálica, con asteriscos o barrabaja.

Énfasis fuerte, conocido como negrita, con arsteriscos o barrasbajas.

Énfasis combinado con asteriscos o barrabaja

Para usar tachado se usa dos tíldes. Tacha esto.

Listas

(En este ejemplo, los espacios iniciales y finales se muestran con puntos: ⋅)

1. Primer elemento de la lista ordenada
2. Otro elemento
⋅⋅* Sub-lista desordenada. 
1. Los números actuales no importan, solo que es un número
⋅⋅1. Sub-lista ordenada
4. Y otro elemento.

⋅⋅⋅Puedes tener párrafos con sangría adecuada dentro de los elementos de la lista. Observa la línea en blanco de arriba, y los espacios iniciales (al menos uno, pero usaremos tres aquí para alinear también el Markdawn en bruto).

⋅⋅⋅Para tener un salto de línea sin un párrafo, necesitarás usar dos espacios finales.⋅⋅
⋅⋅⋅Ten en cuenta que esta línea es separada, pero dentro del mismo párrafo.⋅⋅
⋅⋅⋅(Esto es contrario al comportamiento de salto de línea GFM típico, donde no se requieren espacios finales.)

* En las listas desordenadas puede susar asteriscos
- O usar menos
+ O usar más
  1. Primer elemento de la lista ordenada
  2. Otro elemento ⋅⋅* Sub-lista desordenada.
  3. Los números actuales no importan, solo que es un número ⋅⋅1. Sub-lista ordenada
  4. Y otro elemento.

⋅⋅⋅Puedes tener párrafos con sangría adecuada dentro de los elementos de la lista. Observa la línea en blanco de arriba, y los espacios iniciales (al menos uno, pero usaremos tres aquí para alinear también el Markdawn en bruto).

⋅⋅⋅Para tener un salto de línea sin un párrafo, necesitarás usar dos espacios finales.⋅⋅ ⋅⋅⋅Ten en cuenta que esta línea es separada, pero dentro del mismo párrafo.⋅⋅ ⋅⋅⋅(Esto es contrario al comportamiento de salto de línea GFM típico, donde no se requieren espacios finales.)

  • En las listas desordenadas puede susar asteriscos
  • O usar menos
  • O usar más

Enlaces

Hay dos maneras para crear enlaces.

[Soy un enlace de estilo en linea](https://www.google.com)

[Soy en enlace de estilo con un enlace y un título](https://www.google.com "Google's Homepage")

[Soy en enlace de estilo con referencia][Texto de referencia insensible a mayúsculas / minúsculas]

[Soy una referencia relativa a un archivo del repositorio](../blob/master/LICENSE)

[Puedes usar números para definiciones de enlaces de estilo de referencia][1]

O dejarlo vacío y usa el [enlace de texto en sí].

Las URL y las URL en corchetes angulares se convertirán automáticamente en enlaces.
http://www.ejemplo.com o <http://www.ejemplo.com> y, a veces
ejemplo.com (pero no en Github, por ejemplo).

[Algún texto para mostrar en los enlaces de referencia pueden seguir más adelante.

[texto de referencia insensible a mayúsculas y minúsculas]: https://www.mozilla.org
[1]: http://slashdot.org
[enlace el texto en sí mismo]: http://www.reddit.com

Soy un enlace de estilo en linea

Soy en enlace de estilo con un enlace y un título

[Soy en enlace de estilo con referencia][Texto de referencia insensible a mayúsculas - minúsculas]

Soy una referencia relativa a un archivo del repositorio

Puedes usar números para definiciones de enlaces de estilo de referencia

O dejarlo vacío y usa el [enlace de texto en sí].

Las URL y las URL en corchetes angulares se convertirán automáticamente en enlaces. http://www.ejemplo.com o http://www.ejemplo.com y, a veces ejemplo.com (pero no en Github, por ejemplo).

Algún texto para mostrar en los enlaces de referencia pueden seguir más adelante.

#Imágenes

Aquí hay un logo (ponerse encima para para ver el texto del título):

Estilo en línea: 
![alt text](https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png "Texto del Título 1")

Estilo de referencia: 
![alt text][logo]

[logo]: https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png "Texto del Título 2"

Aquí hay un logo (ponerse encima para para ver el texto del título):

Estilo en línea: alt text

Estilo de referencia: alt text

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment