E25DX

E25DX

Su próximo tema de documentación...

Grabación.de.pantalla.2024-03-12.at.7.32.01.PM.mov

Inspiración

• Cree una documentación técnica sencilla, modular pero personalizable.

• Cree el sitio web sin utilizar node/npm ni ningún marco externo (CSS, JS, icono, fuente).

• Manifestación

Características

• Diseños responsivos y adaptables.

• Modos claros y oscuros incorporados.

• Barras laterales personalizables utilizando plantillas de datos de Hugo.

• Soporte para múltiples conjuntos de documentación.

• Implemente un menú a través de las configuraciones de Hugo.

• Integra búsqueda o asistente de IA.

Empezando

1. Instala Hugo.

• Utilice binarios prediseñados a través de https://github.com/gohugoio/hugo/releases/latest

• Verificar la instalación a través de hugo version

2. Cree un nuevo sitio Hugo con el tema E25DX.

• agregue newsite/content/en/docs/_overview.md para obtener una descripción general

   ---título: URL de descripción general: "docs/descripción general" alias:
  - "/docs"---

• agregue newsite/content/en/docs/a1.hello-world.md como la primera página de la primera sección

   ---título: Hola Worldslug: hola-mundo---

• agregue newsite/content/en/docs/b1.modules.md como la primera página de la segunda sección

   ---título: Modulesslug: módulos---

• agregue newsite/data/en/docs/sidebar.yml para títulos de secciones y títulos de páginas

   - título: Documentación
    páginas:- título: Descripción general- título: Conceptos básicos
    páginas:- título: Hola mundo- título: Más allá de lo básico
    páginas:- título: Módulos

• newsite/hugo.yaml

• newsite/static/sw.js

• newsite/static/manifest.json

• idiomas: en:título y en:descripción

• parámetros: proyecto, autor y hogar

• Prefijo de nombre de caché: ej. hacer-

• nombre, nombre corto, descripción

1. Base

    hugo nuevo sitio newsitecd nuevo sitio
   
   iniciar git
   submódulo git agregar https://github.com/dumindu/E25DX.git themes/E25DX
   
   rm hugo.toml && cp temas/E25DX/hugo.yaml .cp temas/E25DX/static/sw.js ./static/
   temas cp/E25DX/static/manifest.json ./static/

   No necesitamos carpetas de archetypes , assets , i18n layouts generados en la carpeta newsite

2. Configuración

3. Contenido de muestra y barra lateral

4. Ejecute hugo server

   Cambie newsite/hugo.yaml -> enableGitInfo: false , si desea ejecutar hugo server antes de confirmar los cambios.