Markdown

Tabla de contenidos

• Introducción
• Editores de markdown
• Ofimática en markdown
• Páginas web en markdown
• Referencias

Introducción

Markdown es un lenguaje de marcado (markup) que ofrece un enfoque sencillo para la edición de contenido al evitar la sobrecarga que conlleva el HTML. Aunque HTML es ideal para representar el contenido exactamente como previsto, ocupa una gran cantidad líneas y espacio. Markdown ofrece un equilibrio entre la eficacia de HTML para la descripción del contenido y la facilidad del texto sin formato para editarlo, junto con la posibilidad de expandirla si es necesario.

Existen múltiples variantes de Markdown también conocidas como sabores (flavours), el más popular es el de GitHub (GFM), cada una tiene ligeras diferencias de estilo las cuales no suelen diferir mucho. Los archivos de markdown tienen la extension de archivo: .md o .markdown.

Los integrantes del club solemos hacer uso de Markdown en muchos aspectos, para tomar notas en clase, para hacer las presentaciones del club, para hacer documentación de proyectos, para hacer los blogs para esta página, para los README en proyectos de GitHub, entre otros usos. La ventaja de markdown es la facilidad y flexibilidad al escribir, donde múltiples editores son WYSIWYG (acrónimo de «What You See Is What You Get»), donde te permiten escribir un documento mostrando el resultado final. Pero a diferencia de word donde para poner un bloque de código de C++ con formato ocupas el uso de otra herramienta, en markdown es tan fácil y simple como escribir:

    ```c++
    int main(){
        cout << "Hola mundo!";
        return 0;
    }
    ```

Y así de fácil es con muchas más cosas, como la alineación de imágenes, diagramas de flujo, expresiones matemáticas y muchas otras funciones se pueden realizar de manera más fácil y rápido usando markdown, aunque eso si las tablas cuando son muy grandes son difíciles de leer en un editor de texto, por recomiendo usar el generador de tablas para markdown.

Editores de markdown

• VScode es un editor de código expandible, y junto al paquete de extensiones GitHub Markdown Preview se vuelve un muy buen editor de markdown de escritorio y en línea.
• Obsidian esta es la plataforma de notas más popular en todo el mercado, y no por nada, ya que tiene muchísimas funciones para la escritura, como flujos, grafos, mapas mentales, integración de mapas, entre muchas otras opciones por defecto, pero también tiene la posibilidad de instalar plugins para expandir su funcionalidad y en especial recomiendo el plugin de advanced canvas para hacer flujos más visuales.
• notion es una aplicación de productividad con múltiples herramientas enfocadas a la gestión y colaboración como la organización de equipos, control de tiempo, listas de tareas, manejo de proyectos, etc. La desventaja es que no es portable y no solo usa markdown, aparte de tener una licencia de contrato algo invasiva.
• HackMD es una plataforma de colaboración en tiempo real para usar archivos .md y compartirlos al finalizar.
• simplenote es una aplicación más simple enfocada solamente a la toma de notas
• gitjournal esta es una aplicación open source donde tienes notas con control de versión en git, para poder almacenarlas en GitHub, GitLab, Gitea, etc.
• stackedit es un editor de markdown en linea.
• GhostRider es el editor de escritorio de markdown desarrollado por la organización KDE.
• marktext es un editor simple de markdown enfocado en la velocidad y utilidad.

Ofimática en markdown

• marp es un ecosistema de markdown usando el framework de Marpit, esta enfocado a la creación de presentaciones ya sea en obsidian, VScode o la terminal, este es el programa que usamos en el club para hacer las presentaciones del curso, en especifico usamos el tema awesome, pero aun así marp tiene múltiples temas por defecto muy buenos los cuales pueden ser expandidos a través de CSS, aunque no solo se pueden realizar presentaciones, si se desea hacer un documento de tamaño carta recomiendo el uso de este tema us-letter, si no se desea usar alguno de estos temas, recomiendo revisar los repositorios de temas en github.
• slidev es similar a marp pero con opciones de añadir addons, y además cuenta con un catalogo oficial de múltiples temas.
• pandoc este es un convertidor de formatos para la terminal, donde puedes convertir de markdown a múltiples formatos, con temas similares a los encontrados en LaTex como lo seria el beamer.
• Obsidian puede ser expandido con plugins para volverse una de las mejores aplicaciones de ofimática y productividad, donde con la extensión base slides se pueden hacer presentaciones muy buenas, si se quiere exportar a PDF ya viene incluido en el editor por defecto, si quisieras exportar a ‘.docx’ u otros formatos se puede usar la extensión Obsidian Pandoc Plugin para usar la funcionalidad de pandoc dentro de obsidian sin usar la terminal. También para las hojas de cálculo (como en excel) hay diferentes plugins, como lo son: charts, advances y mi favorita spreadsheets.
• VScode con las extensiones: Office Viewer(Markdown Editor), Code Spell CheckerPreview, Word Count y Live Share para poder editar al mismo tiempo que otra persona, este conjunto de extensiones se vuelven una muy buena alternativa a Microsoft Word.

Páginas web en markdown

• jekyll es el creador de páginas estáticas de GitHub hecho con ruby y liquid, su facilidad de uso e implementación en github hace que sea el creador de páginas web favorito del club, donde el tema que usamos y el que más recomendamos es Chirpy
• Hugo utiliza Go en lugar de ruby, por lo que es una opción más popular actualmente, el tema que más recomendamos es Paper Mod
• docusaurus es el creador de páginas estáticas de Facebook usando React y mdx
• Astro es un framework muy popular de JavaScript, donde se tiene la posibilidad de usar mdx y tiene múltiples plantillas gratis disponibles
• Quartz es un creador de páginas estáticas con una muy buena compatibilidad con obsidian.
• GitBook es el creador de documentación más popular en el mercado.

Referencias

• Boswell, B. (2022). Publish your Obsidian Vault Online for Free with Quartz [video]. Recuperado de https://youtu.be/ITiiuBNVue0?si=VpVJ0MaPH1I1SpkM
• Commonmark. (s.f.). Markdown. Recuperado de https://commonmark.org/help/
• GitHub. (s.f). Basic writing and formatting syntax. Recuperado de https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
• Github. (s.f). GitHub Flavored Markdown Spec. Recuperado de https://github.github.com/gfm/
• markdownguide. (s.f.). Markdown guide. Recuperado de https://www.markdownguide.org/
• markdowntutorial. (s.f). Markdown tutorial. Recuperado de https://www.markdowntutorial.com/
• Microsoft. (2023). Learn Markdown reference. Recuperado de https://learn.microsoft.com/en-us/contribute/content/markdown-reference
• Microsoft. (s.f.). Communicate effectively on GitHub using Markdown. Recuperado de https://learn.microsoft.com/es-es/training/modules/communicate-using-markdown/
• Mundi Mark. (2024). Awesome markdown editors. Recuperado de https://github.com/mundimark/awesome-markdown-editors
• Mundi Mark. (2024). Awesome markdown. Recuperado de https://github.com/mundimark/awesome-markdown
• NetworkChuck. (2021). My favorite IT study tool - Notion [video]. Recuperado de https://youtu.be/9Zj3Z4KkcQA?si=Ox6IPPJPhMeKVnFV
• No Boilerplate. (2023). Hack your brain with Obsidian.md [video]. Recuperado de https://youtu.be/DbsAQSIKQXk?si=FenI8YaaOZTW4hcy
• Smith, L. (2017). The Easiest Way to Make Presentations! (Pandoc + Markdown) [video]. Recuperado de https://www.youtube.com/watch?v=dum7q6UXiCE
• Turkel, D. et al. (2024)Learn X in Y minutes Where X=markdown. Recuperado de https://learnxinyminutes.com/docs/markdown/
• Visnovitz, M. (2024). Comparison of syntax extensions in Markdown flavors. Recuperado de https://gist.github.com/vimtaai/99f8c89e7d3d02a362117284684baa0f