GitHub II: MarkDown

Esta es la segunda entrega sobre los tutoriales sobre GitHub; en la anterior entrega vimos como comenzar con GitHub. En esta segunda entrega, os enseñaremos a escribir en MarkDown donde podemos mostrar tanto documentación de nuestro proyecto en un archivo README.md(archivo que mostrará al inicio de nuestro repositorio); además podremos mostrar este contenido en las Wikis de nuestro proyecto y/o Incidencias (issues) o pull request; que otros usuarios pueden escribir en nuestro proyecto(ayuda de parte de la comunidad).

En primer lugar, mostraremos que es Markdown. Markdown es un lenguaje de marcado ligero que trata de conseguir la máxima legibilidad y “publicabilidad” tanto en sus forma de entrada como de salida, inspirándose en muchas convenciones existentes para marcar mensajes de correo electrónico usando texto plano.

Este lenguaje permite de manera sencilla poder escribir documentos con formato y que pueden ser exportados a otro tipo de formatos como HTML o PDF. En este caso, el MarkDown que escribamos en nuestros proyectos se mostrará como html para mostrarlo en las páginas de nuestros proyectos.

En este tutorial, vamos a mostrar en primer lugar, las distintas maneras que tenemos para escribir la documentación de nuestro proyecto tanto en archivos .md como en la wiki o otras partes de nuestro repositorio.

Lo más sencillo para comenzar, es crear un archivo README.md. Este archivo, nos permite tener una documentación de nuestro proyecto que los usuarios que entren a verla podrán consultarla ya que aparece en primer lugar. Para añadirlo, simplemente creamos donde tengamos nuestro repositorio un fichero llamado “Readme.md” y empezar a escribir en markdown en él.

Captura de pantalla 2015-04-30 a las 12.51.58

Una vez que hemos editado el archivo, simplemente con hacer una operación Push(previo commit) se subirá al proyecto y automáticamente podremos verlo en la página de github.

Seguidamente se muestra una tabla con una referencia de todo el formato para escribir en markdown.

Markdown
Muestra
parrafo
Parrafo
*negrita*Negrita
_cursiva_cursiva
[github.com](http://github.com)github.com
![imagen](http://booleanbite.com/web/wp-content/uploads/2015/04/captura4-300x292.jpg)imagen
```java
System.out.println("hola Mundo")
```
# cabecera h1

Cabecera h1

* lista 1
* lista 2

  • lista 1

  • lista 2

1. primer paso
2. segundo paso

  1. primer paso

  2. segundo paso

---

Una vez que tenemos listo nuestro archivo rearme.md o nuestra wiki, con hacer una subida a nuestro repositorio se guardarán los cambios y se mostrarán en nuestro repositorio. Para ayudar a la hora de ver los cambios que hemos realizado en markdown podemos usar un editor online que puede servirnos para poder ver mientras escribimos como quedaría dicho documento. os dejamos el enlace a stackedit.io:

https://stackedit.io

Con este último enlace nos despedimos hasta otra entrega de estos tutoriales sobre Github. Os dejamos un proyecto de github para que podáis consultar el markdown del archivo readme.md.

https://github.com/zerasul/snoozeLib

Be the first to comment on "GitHub II: MarkDown"

Deja un comentario.

Tu dirección de correo no será publicada.


*


*