/docs

Documentation theme created for Hugo without dependencies

Primary LanguageSCSSMIT LicenseMIT

Hugo Docs

Docs

Realicé este proyecto para documentar fácilmente mis propios proyectos, pero pense que estaría genial compartirlo, asi te ahorrarás el tiempo que me tomó aprender todo lo que finalmente, resultó en esta documentación. ¡Ojala realices muchos trabajos!

Características

  • Optimizado compatible con Core Web Vitals
  • Nivel de Seguridad A+ en Mozilla Observatory
  • Soporte para múltiples idiomas
  • Sin dependencias
  • Buscador avanzado automatizado
  • Tema claro y oscuro
  • Shortcodes para alertas, notas, tablas, etc.
  • Bloques de código avanzados
  • Alta personalización

Requisitos

  • Hugo 0.100.0 o superior
  • Git - Instalar Git
  • Ganas de documentar

Instalar

Ve a la raíz de tu proyecto de Hugo y ejecuta el siguiente comando:

git submodule add https://github.com/zkreations/docs themes/docs

Estructura recomendada

Realicé esta documentación pensando en que podrías generar multiples versiones de un mismo proyecto, es por eso que la estructura recomendada debería contener primero un número de versión, por ejemplo:

content
└── 1.0
    └── index.md

Si quieres empezar rápidamente, utiliza el ejemplo que he dejado en la carpeta demo, la cual es la misma que estas leyendo justo ahora. Ejecuta el siguiente comando:

cp -R themes/docs/demo/content .

Configurar

El tema contiene algunas opciones útiles que te pueden ayudar a personalizar aún mas tus documentos. Copia el archivo demo/config.toml y reemplazar la información con tus datos. Por último inicia el servidor local ejecutando:

hugo serve

Contribuciones

Las contribuciones son bienvenidas, sacaré tiempo para revisar cualquier solicitud siempre y cuando tengas en cuenta lo siguiente al realizarlas:

  • No agregar más opciones que puedan incrementar la complejidad.
  • Evitar JavasScript en lo posible si lo puedes realizar con CSS.
  • No intervenir con las opciones personalizadas de los usuarios.

Nota final

Si te gusta este proyecto, considera calificarme con una estrella en github, no cuesta nada y para mi significa mucho. También puedes invitarme un café para que pueda seguir creando cosas como esta.

¡Empieza a documentar!

License

Docs is licensed under the MIT License