Docusaurus - Generador estatico web enfocado en la documentación

in Geek Zone2 months ago

Logo oficial de Docosaurus

Desde hace tiempo les habia 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 @guia-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 @reonfi y yo para 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

image.png

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 esta familiarizado gracias a Peakd, pues es con lo que hemos trabajado.

image.png

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 esta siendo desarrollado en conjunto con Docusaurus y si las cosas salen bien, creo que 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

image.png

¿Tú para qué usarías esta web?, creo que incluso, desde mi punto de vista, para Hive podría servir para tener una mejor documentación sobre como funciona Hive y como usarlo, así para que no quede regado en un sin fin de posts (🤔 ahora que lo pienso no sería una mala idea...), podría usarlo como mini proyecto, bueno, si les gusta déjenme un comentario, siempre estoy encantado de leerlos.

Sort:  


The rewards earned on this comment will go directly to the people( @actioncats ) sharing the post on Twitter as long as they are registered with @poshtoken. Sign up at https://hiveposh.com.

Seré muy sincero amigo Shadow, no entiendo casi nada de programación ni de éste tipo de cosas. Pero aún así puedo felicitarte por tu post, te quedó bonito y tienes una muy buena redacción 🤠.

Saludos y que tengas un excelente comienzo de semana!

!PGM

No te preocupes por no entender nada de programación y gracias por haber leído mi post, me gusta compartir lo que encuentro y mis conocimientos.

Sent 0.1 PGM - 0.1 LVL- 1 STARBITS - 0.05 DEC - 15 SBT tokens to @bananasfallers, @shadowmyst

remaining commands 4

BUY AND STAKE THE PGM TO SEND A LOT OF TOKENS!

The tokens that the command sends are: 0.1 PGM-0.1 LVL-2.5 BUDS-0.01 MOTA-0.05 DEC-15 SBT-1 STARBITS-[0.00000001 BTC (SWAP.BTC) only if you have 2500 PGM in stake or more ]

5000 PGM IN STAKE = 2x rewards!

image.png
Discord image.png

Support the curation account @ pgm-curator with a delegation 10 HP - 50 HP - 100 HP - 500 HP - 1000 HP

Get potential votes from @ pgm-curator by paying in PGM, here is a guide

I'm a bot, if you want a hand ask @ zottone444