martes, 12 de marzo de 2013

Escribir archivos Markdown en Sublime Text

El tipo de documento 'Markdown', o archivos con extensión .md, es sólo un archivo de texto plano (.txt) apropiado para escribir documentos de técnicos, donde la información de formato va escrita en el mismo texto y permite ser renderizado en HTML por intérpretes Markdown.


Los archivos Markdown son usados, por ejemplo, en GitHub para documentar los proyectos (README.md), aunque su utilidad va muchas más allá pudiendo ser un reemplazo interesante al tradicional archivo de Microsoft Word. Su criterio de diseño es que el documento de texto Markdown sea fácil de leer y facil de escribir.

Podemos crear este tipo de archivo en cualquier editor textos, como el notepad de Windows o Sublime Text, y son archivos muy livianos y fáciles de editar.

Preparando Sublime Text para Markdown

Existen varios plugins para trabajar con Markdown en Sublime Text, sugiero descargar el agregado 'Markdown Preview: Preview in browser', se instala desde el *Package control install. Este plugin, como su nombre lo señala, permite que Sublime Text interprete el archivo Markdown y lo despliegue la ventana del navegador instalado en su sistema.

Para escribir la información de formateo de texto, debemos conocer la sintaxis de Markdown que es muy simple y natural.

Sintaxis de Markdown

Para crear un título debemos escribir:

# Este es mi Título

Y generará el código HTML:

    <h1>Este es un título</h1>

Para crear un titulo de nivel inferior se agregan #, por ejemplo:

## Este es un subtítulo

Generará el código:

    <h2>Este es un subtítulo</h2>

Para los párrafos, simplemente escribimos el texto sin dejar espacios al principio de la línea, ni usar identación. Por ejemplo:

Este es un párrafo, donde no debo dejar espacios al inicio de la línea.

Este es un segundo párrafo.

Generará el código:

    <p>Este es un párrafo, donde no debo dejar espacios al inicio de la línea.</p>
    <p>Este es un segundo párrafo.</p>

Creando listas en Markdown

Markdown soporta sólo 2 tipos de listas, las ordenadas y las desordenadas.
Para una lista ordenada se debe escribir un número seguido de un punto y un espacio de tabulación:

1. Primer item.
2. Segundo item.

Producirá el código HTML:

    <ol>
    <li>Primer item.</li>
    <li>Segundo item.</li>
    </ol>

En el caso de una lista desordenada, podemos usar cualquiera de los siguiente símbolos: + - * , por ejemplo:

+ Primer item.
+ Segundo item.

Generará el código HTML:

  
    <ul>
    <li>Primer item.</li>
    <li>Segundo item.</li>
    </ul>

Creando enlaces en Markdown

Existen varias maneras de crear enlaces HTML usando Markdown, la modalidad más simple es:

<http://www.google.com>

Producirá el código HTML siguiente:

<a href="http://www.google.com/">http://www.google.com</a>

O en el caso de una dirección de correo, producirá un código HTML ofuscado, para dificultar la captura del email y evitar spam:

<micorreo@midominio.com>

Ahora, para crear enlaces con un texto distinto a la propia URL se usa:

[El buscador de Google](http://www.google.com/)

Y se creará el código HTML:

<a href="http://www.google.com/">El buscador de Google</a>

Incluyendo código en Markdown

Sin duda la inclusión se código en el texto, es una de las principales razones para usar Markdown. El procedimiento es sencillo, todo lo que se debe hacer es indentar el texto que contendrá el código, por ejemplo se puede escribir:

    <?php 
    //desplegando la configuración actual del intérprete PHP
    echo phpinfo();
    ?>

Y se interpretará en HTML como:

<pre><code>&lt;?php 
//desplegando la configuración actual del intérprete PHP
echo phpinfo();
?&gt;
</code></pre>

Para mayor información acerca de la sintaxis de Markdown sugiero visitar:

No hay comentarios:

Publicar un comentario en la entrada