Hugo Themes
E25DX
Your next documentation theme
- Author: Dumindu Madunuwan
- GitHub Stars: 64
- Updated: 2024-06-23
- License: MIT
- Tags: Dark Mode Docs Light Mode Responsive
π¦ E25DX
Your next documentation theme…
https://github.com/dumindu/E25DX/assets/1280428/00935567-6d50-4e1b-bb0c-cbd159ad37f0
π± Inspiration
- Build a simple, modular but customizable technical documentation.
- Build the website without using node/npm or any external frameworks(CSS, JS, icon, font).
- Demo
β Features
- Responsive and adaptive layouts.
- Built-in light and dark modes.
- Customizable sidebars using Hugo data templates.
- Support for multiple documentation sets.
- Implement a menu via Hugo configs.
- Integrate search or AI assistant.
π Getting Started
Install Hugo.
- Use prebuilt binaries via https://github.com/gohugoio/hugo/releases/latest
- Verify the installation via
hugo version
Create a new Hugo site with the E25DX theme.
Foundation
hugo new site newsite cd newsite git init git submodule add https://github.com/dumindu/E25DX.git themes/E25DX rm hugo.toml && cp themes/E25DX/hugo.yaml . cp themes/E25DX/static/sw.js ./static/ cp themes/E25DX/static/manifest.json ./static/
π‘ We don’t need generated
archetypes
,assets
,i18n
,layouts
folders in thenewsite
folderConfiguration
newsite/hugo.yaml
- languages: en:title and en:description
- params: project, author and home
newsite/static/sw.js
- cacheName prefix: ex. todo-
newsite/static/manifest.json
- name, short_name, description
Sample content and sidebar
- add
newsite/content/en/docs/_overview.md
for overview--- title: Overview url: "docs/overview" aliases: - "/docs" ---
- add
newsite/content/en/docs/a1.hello-world.md
as the first page of first section--- title: Hello World slug: hello-world ---
- add
newsite/content/en/docs/b1.modules.md
as the first page of second section--- title: Modules slug: modules ---
- add
newsite/data/en/docs/sidebar.yml
for section titles and page titles- title: Documentation pages: - title: Overview - title: Basics pages: - title: Hello World - title: Beyond The Basics pages: - title: Modules
- add
Run
hugo server
π‘ Change
newsite/hugo.yaml
->enableGitInfo: false
, if you want to runhugo server
before commit the changes.