E25DX

E25DX

Seu próximo tema de documentação...

Gravação.de.tela.2024-03-12.at.7.32.01.PM.mov

Inspiração

• Crie uma documentação técnica simples, modular, mas personalizável.

• Construa o site sem usar node/npm ou qualquer framework externo (CSS, JS, ícone, fonte).

• Demonstração

Características

• Layouts responsivos e adaptáveis.

• Modos claro e escuro integrados.

• Barras laterais personalizáveis ​​usando modelos de dados Hugo.

• Suporte para vários conjuntos de documentação.

• Implemente um menu através das configurações do Hugo.

• Integre pesquisa ou assistente de IA.

Começando

1. Instale Hugo.

• Use binários pré-construídos via https://github.com/gohugoio/hugo/releases/latest

• Verifique a instalação via hugo version

2. Crie um novo site Hugo com o tema E25DX.

• adicione newsite/content/en/docs/_overview.md para visão geral

   ---title: Visão geralurl: "docs/overview"aliases:
  - "/docs"---

• adicione newsite/content/en/docs/a1.hello-world.md como a primeira página da primeira seção

   ---título: Olá Worldslug: olá-mundo---

• adicione newsite/content/en/docs/b1.modules.md como a primeira página da segunda seção

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

• adicione newsite/data/en/docs/sidebar.yml para títulos de seções e títulos de páginas

   - título: Documentação
    páginas:- título: Visão geral- título: Noções básicas
    páginas: - título: Hello World - título: Beyond The Basics
    páginas: - título: Módulos

• newsite/hugo.yaml

• newsite/static/sw.js

• newsite/static/manifest.json

• idiomas: en:title e en:description

• parâmetros: projeto, autor e home

• Prefixo cacheName: ex. pendência-

• nome, nome_abreviado, descrição

1. Fundação

    hugo novo site newsitecd newsite
   
   git iniciar
   submódulo git adicionar https://github.com/dumindu/E25DX.git temas/E25DX
   
   rm hugo.toml && cp temas/E25DX/hugo.yaml .cp temas/E25DX/static/sw.js ./static/
   cp temas/E25DX/static/manifest.json ./static/

   Não precisamos de pastas archetypes , assets , i18n , layouts geradas na pasta newsite

2. Configuração

3. Exemplo de conteúdo e barra lateral

4. Execute hugo server

   Altere newsite/hugo.yaml -> enableGitInfo: false , se desejar executar hugo server antes de confirmar as alterações.