Docusaurus para webs de documentación

Desde hace tiempo les había dicho que rehice mi web con Middleman, un generador de páginas estáticas, y estaba pensando hacer lo mismo para la web de mi hermano Guía de Mecatronica, pero todo cambio hasta que encontré Docusaurus.

Docusaurus es de igual forma un generador de páginas estáticas escrito en React (de hecho es creado por los desarrolladores de Facebook) y open source, pero con el enfoque relacionado a la documentación. Está pensado esencialmente para todos aquellos desarrolladores de algún software y tengan que hacer la documentación de su código para compartirla al mundo.

Pero no está limitado solo a eso, sino a cualquier tipo de documentación y es justo lo que estábamos pensando mi hermano y yo para nuestra web Guía de Mecatrónica, ya que los posts creados ahora podrán ser debidamente ordenados por capítulos como según lo vayamos viendo, pues de esa forma esta pensado el generador web.

Página de mecatrónica generada por Docusaurus

Otra gran ventaja es que esta Documentación que hagamos la web la podemos ir escribiendo con archivos Markdown o MDX (Markdown con componentes de React) y podremos dejar al último la personalización de la web, quedando prácticamente para su uso instantáneo.

Aunque la versión 2.0 todavía esta en fase beta, recomiendan mas usar esta versión que la primera pues ha tenido muchos cambios y prácticamente quedaría deprecada, asi que mejor que trabajar con la versión mas actual posible.

Solo requieres tener conocimientos básicos de React, JS obviamente, HTML5 y CSS, para que puedas personalizarla a tu gusto, aunque si no tienes conocimientos de ello, prácticamente al ejecutar la “instalación”, te creará lo suficiente para que comiences a editar y la documentación es muy sencilla de realizar.

Estructura de archivos en VSCode

Si vemos la imagen anterior, podemos que la estructura de archivos no es una gran ciencia y como mencione con Markdown puedes andar construyendo los posts sin gran problema, algo que uno, pues ya está familiarizado gracias a Peakd, pues es con lo que hemos trabajado.

Pagina principal de Guía de Mecatrónica

Aún estoy cambiando poco a poco la plantilla que me da por default para crear la web y ya estoy empezando a pasar todo lo subido a esta versión, instale bulma.io para que sea mi especie de Framework CSS, aunque ya le estoy dando un ojo a infima otro Framework de estilos que está siendo desarrollado en conjunto con Docusaurus y si las cosas salen bien, creo qué podre dejar, por un lado, a Bulma.

También las pocas cosas que ando usando de React me está sirviendo para aprender, pues apenas ando empezando a aprender su uso y puedo experimentar con la propia web para mejorar mi aprendizaje. Pues siempre he pensado que no hay mejor forma de mejorar tus conocimientos que ir practicando con proyectos propios que pueden llegar mas lejos.

Si vemos dentro de su sección “showcase” en Docusaurus podemos ver que otras páginas web eran usándolo, desde obviamente páginas que buscan documentar su código para que el usuario lo pueda usar, asi como algunas personas que lo tienen como portfolio u otras páginas de uso personal

Todas las paginas que usan Docusaurus

En un par de dias la nueva versión de la web que ando construyendo tendra su nueva versión, ya que estare usando este generador web, ya veremos que tal ha resultado

¡Los anuncios me ayudan!

Hola. Este blog se mantiene gracias a algunos banners de publicidad. Si tienes bloqueador de anuncios te pido que nos pongas en tu whitelist.

La publicidad de este sitio no es invasiva. O si prefieres podrias dar una pequeña donación en las diferentes criptomonedas de este sitio.

Por tu atención gracias