E25DX

E25DX

Votre prochain thème de documentation...

Enregistrement.d'écran.2024-03-12.at.7.32.01.PM.mov

Inspiration

• Construisez une documentation technique simple, modulaire mais personnalisable.

• Créez le site Web sans utiliser node/npm ou tout framework externe (CSS, JS, icône, police).

• Démo

Caractéristiques

• Mises en page réactives et adaptatives.

• Modes clair et sombre intégrés.

• Barres latérales personnalisables à l'aide des modèles de données Hugo.

• Prise en charge de plusieurs ensembles de documentation.

• Implémentez un menu via les configurations Hugo.

• Intégrez la recherche ou l’assistant IA.

Commencer

1. Installez Hugo.

• Utilisez des binaires prédéfinis via https://github.com/gohugoio/hugo/releases/latest

• Vérifier l'installation via hugo version

2. Créez un nouveau site Hugo avec le thème E25DX.

• ajoutez newsite/content/en/docs/_overview.md pour un aperçu

   ---titre : URL d'aperçu : alias "docs/overview" :
  - "/docs" ---

• ajouter newsite/content/en/docs/a1.hello-world.md comme première page de la première section

   ---titre : Bonjour Worldslug : bonjour-monde---

• ajouter newsite/content/en/docs/b1.modules.md comme première page de la deuxième section

   ---titre : Modulesslug : modules---

• ajoutez newsite/data/en/docs/sidebar.yml pour les titres de section et les titres de page

   - titre : Documentation
    pages : - titre : Présentation - titre : Bases
    pages : - titre : Hello World - titre : Au-delà des bases
    pages : - titre : Modules

• newsite/hugo.yaml

• newsite/static/sw.js

• newsite/static/manifest.json

• langues : fr:titre et fr:description

• paramètres : projet, auteur et maison

• Préfixe cacheName : ex. faire-

• nom, nom_court, description

1. Fondation

    Hugo nouveau site nouveau site cd nouveau site
   
   git init
   sous-module git ajouter https://github.com/dumindu/E25DX.git Themes/E25DX
   
   rm hugo.toml && cp thèmes/E25DX/hugo.yaml .cp thèmes/E25DX/static/sw.js ./static/
   cp thèmes/E25DX/static/manifest.json ./static/

   Nous n'avons pas besoin des dossiers archetypes , assets , i18n et layouts générés dans le dossier newsite

2. Configuration

3. Exemple de contenu et barre latérale

4. Exécuter hugo server

   Modifiez newsite/hugo.yaml -> enableGitInfo: false , si vous souhaitez exécuter hugo server avant de valider les modifications.