Tutorial de Markdown

Markdown es un lenguaje de marcado ligero que permite a las personas redactar documentos utilizando un formato de texto plano fácil de leer y escribir.

El lenguaje Markdown fue creado en 2004 por John Gruber.

La filosofía de diseño de Markdown es «fácil de leer y fácil de escribir», permitiendo a las personas crear documentos estructurados utilizando un formato de texto plano simple.

Los documentos escritos en Markdown se pueden exportar a varios formatos como HTML, Word, imágenes, PDF, Epub, etc.

Los documentos escritos en Markdown tienen la extensión.md, .markdown。

Las características principales de Markdown incluyen:

Simplicidad: utiliza símbolos intuitivos para representar el formato, por ejemplo, con#para los títulos, y con*para los elementos de lista. Estos símbolos transmiten su significado visualmente; incluso sin renderizar tienen buena legibilidad.

Legibilidad: incluso un documento Markdown en texto plano puede mostrar claramente la estructura y jerarquía del documento. Los lectores pueden entender la organización del contenido sin necesidad de software especializado.

Portabilidad: los archivos Markdown están en formato de texto plano, se pueden abrir y editar en cualquier editor de texto, sin depender de un software o sistema operativo específico.

Convertibilidad: se puede convertir fácilmente a HTML, PDF, Word y otros formatos para satisfacer diferentes necesidades de publicación.

Concepto de lenguaje de marcado ligero

Un lenguaje de marcado es un lenguaje que utiliza símbolos específicos para describir la estructura y el formato de un documento. Los lenguajes de marcado tradicionales como HTML son potentes pero tienen una sintaxis compleja, mientras que los lenguajes de marcado ligeros simplifican este proceso.

En comparación con HTML, las ventajas de Markdown son:

  • Bajo costo de aprendizaje, se pueden dominar los conceptos básicos en unos minutos
  • Alta eficiencia de escritura, no es necesario escribir etiquetas complejas
  • Concéntrese en el contenido, no en los detalles de formato
  • Amigable con el control de versiones, fácil para la colaboración y el seguimiento de cambios

Relación entre Markdown y HTML

Markdown no es un reemplazo de HTML, sino una versión simplificada de HTML. De hecho, el objetivo final de Markdown es convertirse en HTML. La relación entre ambos se puede entender así:

Markdown 源码 → 解析器 → HTML 输出 → 浏览器渲染

Por ejemplo, cuando escribes:

# Este es un título

Se convertirá en:

<h1>这是一个标题</h1>

Es importante que en Markdown puedes usar etiquetas HTML directamente, lo que proporciona flexibilidad para formatos complejos. Cuando la sintaxis básica de Markdown no satisface las necesidades, se puede incrustar código HTML para lograr efectos específicos.

Por qué elegir Markdown

Mejorar la eficiencia de escritura: no es necesario usar el ratón con frecuencia para configurar el formato, lo que mantiene la continuidad del pensamiento. El escritor puede concentrarse en la creación de contenido sin distraerse con problemas de formato.

Reducir la barrera de aprendizaje: en comparación con lenguajes de marcado como LaTeX o HTML, la sintaxis de Markdown es extremadamente simple; la mayoría de las personas pueden dominar su uso básico en una hora.

Amplia compatibilidad: casi todos los editores de texto modernos, editores de código y aplicaciones de notas son compatibles con Markdown. Desde un simple bloc de notas hasta IDE profesionales, puedes encontrar Markdown en todas partes.

Amigable con el control de versiones: al ser un formato de texto plano, los archivos Markdown se integran bien con sistemas de control de versiones como Git, lo que facilita el seguimiento del historial de cambios y la colaboración en equipo.

Adaptabilidad futura: incluso si un software o plataforma específica desaparece, los archivos Markdown, al ser texto plano, siguen siendo accesibles y editables, lo que garantiza la disponibilidad a largo plazo del contenido.

Casos de uso de Markdown

Redacción de documentación técnica

En el ámbito del desarrollo de software, Markdown se ha convertido en el formato estándar para la documentación técnica. Es especialmente adecuado para:

  • Documentación de API: los niveles claros de títulos y la presentación de bloques de código hacen que las descripciones de API sean profesionales y legibles. Muchas herramientas de generación de documentación de API (como Swagger) son compatibles con descripciones en formato Markdown.

  • Descripción del proyecto: desde guías de instalación hasta manuales de uso, Markdown puede organizar eficazmente la información técnica. Los ejemplos de código, archivos de configuración y operaciones de línea de comandos se muestran adecuadamente.

  • Normas de desarrollo: las normas de codificación del equipo, las pautas de diseño, los flujos de trabajo, etc., se pueden escribir en Markdown, lo que facilita su consulta y actualización por parte de los miembros del equipo.

Creación de artículos de blog

La mayoría de las plataformas de blogs modernas y los generadores de sitios estáticos son compatibles con Markdown:

  • Gestión de contenido: los blogueros pueden centrarse en la creación de contenido sin preocuparse por la codificación HTML compleja. El formato de los artículos se realiza con simples marcadores.

  • Migración de plataforma: los artículos escritos en Markdown se pueden migrar fácilmente entre diferentes plataformas, sin estar bloqueados por formatos específicos de una plataforma.

  • Escritura sin conexión: puede escribir artículos sin conexión en cualquier editor de texto y luego publicarlos por lotes, lo que aumenta la flexibilidad de la escritura.

Archivo README de GitHub

La plataforma GitHub utiliza ampliamente Markdown, especialmente en los archivos README de los proyectos:

  • Introducción del proyecto: muestra claramente información clave como el propósito del proyecto, sus características y cómo usarlo.

  • Guía de instalación: proporciona pasos detallados de instalación y configuración mediante bloques de código y listas.

  • Guía de contribución: explica cómo participar en el desarrollo del proyecto, incluyendo normas de código, proceso de envío de contribuciones, etc.

  • Seguimiento de problemas: en Issues y Pull Requests, los desarrolladores usan Markdown para describir problemas y proporcionar soluciones.

Toma de notas y gestión del conocimiento

Markdown se está convirtiendo en el formato preferido para las notas digitales:

  • Notas de estudio: admite varios tipos de contenido como fórmulas matemáticas, resaltado de código, gráficos, etc., adecuado para el aprendizaje técnico y la organización del conocimiento.

  • Actas de reuniones: una estructura de títulos clara y un formato de listas hacen que los puntos clave de la reunión sean evidentes de un vistazo.

  • Construcción de base de conocimiento: tanto empresas como individuos están utilizando Markdown para construir bases de conocimiento, organizando la información mediante enlaces y etiquetas.

Plataformas de escritura en línea

Cada vez más plataformas de escritura comienzan a ser compatibles con Markdown:

  • GitHub, Jianshu, Zhihu: los editores de estas plataformas son compatibles con la sintaxis de Markdown, lo que permite a los creadores formatear artículos rápidamente.

  • GitBook、Notion: plataformas profesionales de documentos y notas, compatibles nativamente con Markdown, que ofrecen potentes funciones de organización y colaboración.

  • Generadores de blogs estáticos: herramientas como Jekyll, Hugo, Hexo, etc., permiten a los usuarios crear sitios web profesionales con Markdown.

Libros útiles

«El increíble Markdown»:

Otras extensiones