Tutorial de Markdown

Markdown es un lenguaje de marcado ligero que permite a las personas escribir 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 escribir", lo que permite a las personas crear documentos estructurados utilizando un simple formato de texto plano.

Los documentos escritos en Markdown se pueden exportar a HTML, Word, imágenes, PDF, Epub y otros formatos.

La extensión de los documentos escritos en Markdown es.md, .markdown。

Las características principales de Markdown incluyen:

Simplicidad: para representar el formato se utilizan símbolos intuitivos, como usar#para representar títulos, y*para representar elementos de lista. Estos símbolos transmiten su significado visualmente, y tienen buena legibilidad incluso sin renderizar.

Legibilidad: incluso en forma de texto plano, un documento Markdown puede mostrar claramente la estructura y jerarquía del documento. Los lectores no necesitan software especializado para comprender la organización del contenido.

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

Convertibilidad: Puede convertirse fácilmente a HTML, PDF, Word y otros formatos, satisfaciendo 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 con una sintaxis compleja, mientras que los lenguajes de marcado ligero simplifican este proceso.

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

  • Bajo costo de aprendizaje: se puede dominar la sintaxis básica en unos minutos.
  • Alta eficiencia de escritura: no es necesario escribir etiquetas complejas.
  • Centrarse en el contenido, no en los detalles de formato.
  • Amigable con el control de versiones, facilita 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 puede entenderse así:

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

Por ejemplo, cuando escribes:

# Este es un título

Se convierte en:

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

Lo importante es que en Markdown puedes usar directamente etiquetas HTML, lo que brinda 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 mouse con frecuencia para configurar el formato, lo que mantiene la fluidez de las ideas. 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 y HTML, la sintaxis de Markdown es extremadamente simple; la mayoría de las personas pueden dominar el 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 bloc de notas simples hasta IDE profesionales, puedes encontrar Markdown en todas partes.

Amigable con el control de versiones: Al estar en 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, como texto plano, siguen siendo accesibles y editables, lo que garantiza la disponibilidad a largo plazo del contenido.

Escenarios de aplicación 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: La clara jerarquía de títulos y la presentación de bloques de código hacen que la documentación de API sea profesional y legible. Muchas herramientas de generación de documentación de API (como Swagger) admiten 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.

  • Estándares de desarrollo: Las normas de codificación, principios de diseño, flujos de trabajo, etc., del equipo pueden redactarse 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 generadores de sitios estáticos son compatibles con Markdown:

  • Gestión de contenido: Los blogueros pueden concentrarse en la creación de contenido sin preocuparse por la compleja codificación HTML. El formateo de los artículos se logra mediante marcado simple.

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

  • Escritura sin conexión: Puedes escribir artículos sin conexión en cualquier editor de texto y luego publicarlos por lotes, lo que aumenta la flexibilidad de 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, características, métodos de uso, etc.

  • 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 commits, 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, diagramas, etc., adecuado para el aprendizaje técnico y la organización del conocimiento.

  • Actas de reuniones: La estructura clara de títulos y el formato de listas hacen que los puntos clave de la reunión se vean de un vistazo.

  • Construcción de bases de conocimiento: Empresas e individuos están utilizando Markdown para construir bases de conocimiento, organizando 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 documentación y notas, con soporte nativo de Markdown, ofrecen potentes funciones de organización y colaboración.

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

Libros útiles

«El increíble Markdown»:

Otras extensiones