E25DX

E25DX

Ваша следующая тема документации...

Экран.Запись.12.03.2024.at.32.07.01.PM.mov

Вдохновение

• Создайте простую, модульную, но настраиваемую техническую документацию.

• Создайте веб-сайт без использования node/npm или каких-либо внешних фреймворков (CSS, JS, значков, шрифтов).

• Демо

Функции

• Отзывчивые и адаптивные макеты.

• Встроенные светлый и темный режимы.

• Настраиваемые боковые панели с использованием шаблонов данных Hugo.

• Поддержка нескольких наборов документации.

• Реализуйте меню через конфиги Hugo.

• Интегрируйте поиск или помощник AI.

Начиная

1. Установите Хьюго.

• Используйте готовые двоичные файлы через https://github.com/gohugoio/hugo/releases/latest.

• Проверьте установку через hugo version

2. Создайте новый сайт Hugo с темой E25DX.

• добавьте newsite/content/en/docs/_overview.md для обзора

   ---title: Обзорurl: "docs/overview"псевдонимы:
  - "/документы"---

• добавьте newsite/content/en/docs/a1.hello-world.md в качестве первой страницы первого раздела

   ---title: Hello Worldslug: hello-world---

• добавьте newsite/content/en/docs/b1.modules.md в качестве первой страницы второго раздела

   ---title: Modulesslug: модули---

• добавьте newsite/data/en/docs/sidebar.yml для заголовков разделов и заголовков страниц.

   - название: Документация
    страницы:- title: Обзор- title: Основы
    страницы:- title: Hello World- title: Beyond The Basics
    страницы:- название: Модули

• newsite/hugo.yaml

• newsite/static/sw.js

• newsite/static/manifest.json

• языки: en:title и en:description

• параметры: проект, автор и дом.

• Префикс имени кэша: например. дела-

• имя, короткое_имя, описание

1. Фундамент

    Новый сайт Хьюго
   
   git инициализация
   Подмодуль git добавить https://github.com/dumindu/E25DX.git themes/E25DX
   
   rmhugo.toml && cp themes/E25DX/hugo.yaml .cp themes/E25DX/static/sw.js ./static/
   cp themes/E25DX/static/manifest.json ./static/

   Нам не нужны папки сгенерированные archetypes , assets , i18n , layouts в папке newsite .

2. Конфигурация

3. Пример контента и боковая панель

4. Запустить hugo server

   Измените newsite/hugo.yaml -> enableGitInfo: false , если вы хотите запустить hugo server перед подтверждением изменений.