La X en MDX

Rate this content
Bookmark

Markdown es genial para sitios impulsados por contenido. MDX es aún mejor, ya que te permite incrustar componentes interactivos directamente desde tu marcado. Por lo general, se utiliza para los mismos diseños lineales que a menudo se ven en muchos blogs, readmes y sitios de documentación. Pero no tiene que ser así.


En esta charla, veremos cómo remodelar MDX para poder utilizarlo en diseños muy diferentes, como scrollytelling, presentaciones de diapositivas y más.

9 min
17 Jun, 2021

Video Summary and Transcription

Markdown se amplía con MDX para admitir más contenido y diseños. MDX permite la personalización de la representación y extracción de datos. A menudo se utiliza para incrustar componentes interactivos. MDX se puede utilizar para crear diseños personalizados y sincronizar pasos con medios. Codehike es un proyecto centrado en herramientas de pared de código y explicación de código.

Available in English

1. Introducción a MDX y Componentes React

Short description:

Markdown es popular debido a su sintaxis limpia. MDX extiende Markdown para admitir más contenido y diseños. El cargador de MDX transforma archivos Markdown en componentes React. El proveedor de MDX nos permite anular los componentes predeterminados y personalizar la representación. El componente envolvente proporciona acceso al contenido del archivo Markdown como elementos React. Podemos extraer información o modificar elementos utilizando el tipo MDX.

Ambos tienen videos de revisión, videos, comentarios, más videos, otros videos, videos de marca, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, subtítulos, sub

2. MDX y Pasos

Short description:

En MDX, podemos extraer datos de los hijos y representarlos de una manera específica. Si el rendimiento es una preocupación, podemos mover la extracción a un complemento de tiempo de compilación. MDX nos permite introducir nuestra propia sintaxis para iterar cosas en pasos. El componente Step se utiliza para agrupar elementos. MDX es una extensión de sintaxis para Markdown, a menudo utilizado para incrustar componentes interactivos.

En todos ellos, primero extraemos algunos data de los hijos y luego lo representamos de una manera específica. Ten en cuenta que esto se ejecuta en cada representación. En la mayoría de los casos, no es un problema de rendimiento, pero si lo es, puedes moverlo a un complemento y ejecutar la transformación en tiempo de compilación.

Normalmente escribo contenido que tiene pasos, como tutoriales o cualquier tipo de guía donde se explica algo paso a paso. Markdown no tiene una sintaxis específica para iterar cosas en pasos, pero podemos usar MDX para extender Markdown e introducir nuestra propia sintaxis.

La implementación del componente Step que estamos utilizando aquí no importa, simplemente lo estamos utilizando para agrupar elementos. Si eres nuevo en MDX, esta puede no ser la mejor introducción. El caso de uso típico para MDX es incrustar componentes interactivos en Markdown, pero aquí estamos adoptando un enfoque diferente y usándolo más como una extensión de sintaxis para Markdown.

3. Pasos y Diseños de Archivos MDX

Short description:

Ahora, basado en el archivo MDX que tiene pasos, podemos escribir otro componente envolvente. En este caso, obtenemos un elemento React para cada paso, por lo que podemos realizar un seguimiento del paso actual y permitir al usuario cambiarlo con un botón. Implementemos un diseño de desplazamiento con pegatinas donde algunas partes se mantienen en la pantalla mientras el resto se desplaza. Podemos agregar contenido adhesivo al archivo MDX y usar un componente de diseño para mostrar la pegatina correspondiente cuando el usuario se desplaza a un nuevo paso. También podemos sincronizar los pasos con medios como un video o audio utilizando el componente TalkLayout.

Ahora, basado en el archivo MDX que tiene pasos, podemos escribir otro componente envolvente. En este caso, en la propiedad children, obtenemos un elemento React para cada paso, por lo que podemos realizar un seguimiento del paso actual utilizando el estado de react y permitir que el usuario cambie el paso actual con un botón.

Ahora, quiero mostrar el mismo contenido, pero con un diseño diferente. Existe una técnica llamada desplazamiento con pegatinas. Es posible que la hayas visto en algunos sitios web. A medida que el usuario se desplaza hacia abajo, hay alguna parte del diseño que se mantiene en la pantalla, mientras que el resto se desplaza. Así que hagámoslo. Como esta es una masterclass, importaré el componente de diseño de desplazamiento con pegatinas. Compartiré el enlace al repositorio más adelante, si quieres ver cómo funciona. El componente de diseño de desplazamiento con pegatinas recibe dos propiedades, una para el lado izquierdo que se puede desplazar y otra para la parte adhesiva a la derecha. Cuando el usuario se desplaza a un nuevo paso, mostramos el elemento correspondiente de la lista de pegatinas.

Ahora, en lugar de mostrar el número de paso, agreguemos el contenido de la pegatina al archivo MDX. Supongamos que queremos mostrar algún código en esta parte adhesiva del diseño. No hay una sintaxis específica para esto, así que necesitamos crear nuestra propia convención. Por ejemplo, podemos colocar la parte adhesiva del paso como el primer elemento. Luego, realizando alguna transformación de matriz, obtenemos la lista de pasos y la lista de pegatinas y las pasamos al mismo componente de diseño. Entonces, cuando el usuario se desplaza, el código a la derecha debería cambiar en consecuencia. Solo por diversión, tengo un componente de terminal que anima entre transiciones de código, por lo que podemos usarlo para las pegatinas.

He estado experimentando con otro diseño para las masterclass. En lugar de cambiar los pasos utilizando el desplazamiento como en este ejemplo, podemos sincronizar estos pasos con algún medio como un video o un audio, tal vez un podcast, y cambiar los pasos a medida que avanza el medio. Para hacer eso en el archivo mdx, necesitamos especificar el archivo de medios y el rango de tiempo para cada paso. Una vez que tengamos eso, podemos extraer la información de los hijos en el componente envolvente y pasarla a otro componente React. Esta vez es el componente TalkLayout el que resolverá toda la sincronización por nosotros. Y deberías ver los pasos cambiando cada vez que chasqueo los dedos.

Algunos de ustedes pueden haber notado que esto se parece al diseño de esta masterclass que estoy dando en este momento. Y lo es. Esta charla se construyó utilizando la misma técnica. Todo es MDX. Por ejemplo, aquí a la izquierda puedes ver el código de los pasos que estás viendo actualmente. Y aquí está el siguiente paso.

4. Key Takeaways and Codehike

Short description:

Puedes usar MDX para construir tu propio dialecto para cualquier diseño. Se proporcionan enlaces al repositorio de la charla. Ejecuta Yarn dev para ver la charla nuevamente. Echa un vistazo a mi Twitter y a los componentes de Codehike, un proyecto enfocado en herramientas de pared de código y explicación de código.

Y eso es todo lo que tengo. Las conclusiones. Puedes usar MDX para construir tu propio dialecto adaptado para cualquier diseño específico. Aquí te dejo los enlaces al repositorio de la charla. No las diapositivas, sino la charla en sí. Ejecutas Yarn dev y puedes ver esta charla nuevamente.

Y aquí está mi Twitter y los componentes que usamos. La mayoría de ellos provienen de un nuevo proyecto en el que estoy trabajando. Se llama Codehike. Y se enfoca en herramientas de pared de código. Y herramientas para facilitar la explicación del código. Gracias.

Check out more articles and videos

We constantly think of articles and videos that might spark Git people interest / skill us up or help building a stellar career

React Advanced Conference 2022React Advanced Conference 2022
25 min
A Guide to React Rendering Behavior
Top Content
React is a library for "rendering" UI from components, but many users find themselves confused about how React rendering actually works. What do terms like "rendering", "reconciliation", "Fibers", and "committing" actually mean? When do renders happen? How does Context affect rendering, and how do libraries like Redux cause updates? In this talk, we'll clear up the confusion and provide a solid foundation for understanding when, why, and how React renders. We'll look at: - What "rendering" actually is - How React queues renders and the standard rendering behavior - How keys and component types are used in rendering - Techniques for optimizing render performance - How context usage affects rendering behavior| - How external libraries tie into React rendering
React Summit Remote Edition 2021React Summit Remote Edition 2021
33 min
Building Better Websites with Remix
Top Content
Remix is a new web framework from the creators of React Router that helps you build better, faster websites through a solid understanding of web fundamentals. Remix takes care of the heavy lifting like server rendering, code splitting, prefetching, and navigation and leaves you with the fun part: building something awesome!
React Advanced Conference 2023React Advanced Conference 2023
33 min
React Compiler - Understanding Idiomatic React (React Forget)
React provides a contract to developers- uphold certain rules, and React can efficiently and correctly update the UI. In this talk we'll explore these rules in depth, understanding the reasoning behind them and how they unlock new directions such as automatic memoization. 
React Advanced Conference 2022React Advanced Conference 2022
30 min
Using useEffect Effectively
Top Content
Can useEffect affect your codebase negatively? From fetching data to fighting with imperative APIs, side effects are one of the biggest sources of frustration in web app development. And let’s be honest, putting everything in useEffect hooks doesn’t help much. In this talk, we'll demystify the useEffect hook and get a better understanding of when (and when not) to use it, as well as discover how declarative effects can make effect management more maintainable in even the most complex React apps.
React Summit 2022React Summit 2022
20 min
Routing in React 18 and Beyond
Top Content
Concurrent React and Server Components are changing the way we think about routing, rendering, and fetching in web applications. Next.js recently shared part of its vision to help developers adopt these new React features and take advantage of the benefits they unlock.In this talk, we’ll explore the past, present and future of routing in front-end applications and discuss how new features in React and Next.js can help us architect more performant and feature-rich applications.
React Advanced Conference 2021React Advanced Conference 2021
27 min
(Easier) Interactive Data Visualization in React
Top Content
If you’re building a dashboard, analytics platform, or any web app where you need to give your users insight into their data, you need beautiful, custom, interactive data visualizations in your React app. But building visualizations hand with a low-level library like D3 can be a huge headache, involving lots of wheel-reinventing. In this talk, we’ll see how data viz development can get so much easier thanks to tools like Plot, a high-level dataviz library for quick & easy charting, and Observable, a reactive dataviz prototyping environment, both from the creator of D3. Through live coding examples we’ll explore how React refs let us delegate DOM manipulation for our data visualizations, and how Observable’s embedding functionality lets us easily repurpose community-built visualizations for our own data & use cases. By the end of this talk we’ll know how to get a beautiful, customized, interactive data visualization into our apps with a fraction of the time & effort!

Workshops on related topic

React Summit 2023React Summit 2023
170 min
React Performance Debugging Masterclass
Featured WorkshopFree
Ivan’s first attempts at performance debugging were chaotic. He would see a slow interaction, try a random optimization, see that it didn't help, and keep trying other optimizations until he found the right one (or gave up).
Back then, Ivan didn’t know how to use performance devtools well. He would do a recording in Chrome DevTools or React Profiler, poke around it, try clicking random things, and then close it in frustration a few minutes later. Now, Ivan knows exactly where and what to look for. And in this workshop, Ivan will teach you that too.
Here’s how this is going to work. We’ll take a slow app → debug it (using tools like Chrome DevTools, React Profiler, and why-did-you-render) → pinpoint the bottleneck → and then repeat, several times more. We won’t talk about the solutions (in 90% of the cases, it’s just the ol’ regular useMemo() or memo()). But we’ll talk about everything that comes before – and learn how to analyze any React performance problem, step by step.
(Note: This workshop is best suited for engineers who are already familiar with how useMemo() and memo() work – but want to get better at using the performance tools around React. Also, we’ll be covering interaction performance, not load speed, so you won’t hear a word about Lighthouse 🤐)
React Advanced Conference 2021React Advanced Conference 2021
132 min
Concurrent Rendering Adventures in React 18
Top Content
Featured WorkshopFree
With the release of React 18 we finally get the long awaited concurrent rendering. But how is that going to affect your application? What are the benefits of concurrent rendering in React? What do you need to do to switch to concurrent rendering when you upgrade to React 18? And what if you don’t want or can’t use concurrent rendering yet?

There are some behavior changes you need to be aware of! In this workshop we will cover all of those subjects and more.

Join me with your laptop in this interactive workshop. You will see how easy it is to switch to concurrent rendering in your React application. You will learn all about concurrent rendering, SuspenseList, the startTransition API and more.
React Summit Remote Edition 2021React Summit Remote Edition 2021
177 min
React Hooks Tips Only the Pros Know
Top Content
Featured Workshop
The addition of the hooks API to React was quite a major change. Before hooks most components had to be class based. Now, with hooks, these are often much simpler functional components. Hooks can be really simple to use. Almost deceptively simple. Because there are still plenty of ways you can mess up with hooks. And it often turns out there are many ways where you can improve your components a better understanding of how each React hook can be used.You will learn all about the pros and cons of the various hooks. You will learn when to use useState() versus useReducer(). We will look at using useContext() efficiently. You will see when to use useLayoutEffect() and when useEffect() is better.
React Advanced Conference 2021React Advanced Conference 2021
174 min
React, TypeScript, and TDD
Top Content
Featured WorkshopFree
ReactJS is wildly popular and thus wildly supported. TypeScript is increasingly popular, and thus increasingly supported.

The two together? Not as much. Given that they both change quickly, it's hard to find accurate learning materials.

React+TypeScript, with JetBrains IDEs? That three-part combination is the topic of this series. We'll show a little about a lot. Meaning, the key steps to getting productive, in the IDE, for React projects using TypeScript. Along the way we'll show test-driven development and emphasize tips-and-tricks in the IDE.
React Advanced Conference 2021React Advanced Conference 2021
145 min
Web3 Workshop - Building Your First Dapp
Top Content
Featured WorkshopFree
In this workshop, you'll learn how to build your first full stack dapp on the Ethereum blockchain, reading and writing data to the network, and connecting a front end application to the contract you've deployed. By the end of the workshop, you'll understand how to set up a full stack development environment, run a local node, and interact with any smart contract using React, HardHat, and Ethers.js.
React Summit 2023React Summit 2023
151 min
Designing Effective Tests With React Testing Library
Featured Workshop
React Testing Library is a great framework for React component tests because there are a lot of questions it answers for you, so you don’t need to worry about those questions. But that doesn’t mean testing is easy. There are still a lot of questions you have to figure out for yourself: How many component tests should you write vs end-to-end tests or lower-level unit tests? How can you test a certain line of code that is tricky to test? And what in the world are you supposed to do about that persistent act() warning?
In this three-hour workshop we’ll introduce React Testing Library along with a mental model for how to think about designing your component tests. This mental model will help you see how to test each bit of logic, whether or not to mock dependencies, and will help improve the design of your components. You’ll walk away with the tools, techniques, and principles you need to implement low-cost, high-value component tests.
Table of contents- The different kinds of React application tests, and where component tests fit in- A mental model for thinking about the inputs and outputs of the components you test- Options for selecting DOM elements to verify and interact with them- The value of mocks and why they shouldn’t be avoided- The challenges with asynchrony in RTL tests and how to handle them
Prerequisites- Familiarity with building applications with React- Basic experience writing automated tests with Jest or another unit testing framework- You do not need any experience with React Testing Library- Machine setup: Node LTS, Yarn