https://github.com/dumindu/e25dx
🧑💻 Your next documentation theme...
https://github.com/dumindu/e25dx
documentation gohugo gohugo-theme hugo hugo-theme
Last synced: 23 days ago
JSON representation
🧑💻 Your next documentation theme...
- Host: GitHub
- URL: https://github.com/dumindu/e25dx
- Owner: dumindu
- License: mit
- Created: 2024-01-01T13:01:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-22T16:45:15.000Z (about 1 month ago)
- Last Synced: 2025-04-09T21:14:28.934Z (23 days ago)
- Topics: documentation, gohugo, gohugo-theme, hugo, hugo-theme
- Language: CSS
- Homepage:
- Size: 453 KB
- Stars: 81
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.buymeacoffee.com/dumindu)
# 🦄 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
- [](https://learning-rust.github.io)
- [](https://learning-cloud-native-go.github.io)
## ✅ Features
- [x] Responsive and adaptive layouts.
- [x] Built-in light and dark modes.
- [x] Customizable sidebars using Hugo data templates.
- [ ] Support for multiple documentation sets.
- [ ] Implement a menu via Hugo configs.
- [ ] Integrate search or AI assistant.
## 🚀 Getting Started
1. [Install Hugo](https://gohugo.io/installation/).
- Use prebuilt binaries via https://github.com/gohugoio/hugo/releases/latest
- Verify the installation via `hugo version`
2. Create a new Hugo site with the E25DX theme.
1. Foundation
```shell
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 the `newsite` folder
2. Configuration
- `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
3. Sample content and sidebar
- add `newsite/content/en/docs/_overview.md` for overview
```markdown
---
title: Overview
url: "docs/overview"
aliases:
- "/docs"
---
```
- add `newsite/content/en/docs/a1.hello-world.md` as the first page of first section
```markdown
---
title: Hello World
slug: hello-world
---
```
- add `newsite/content/en/docs/b1.modules.md` as the first page of second section
```markdown
---
title: Modules
slug: modules
---
```
- add `newsite/data/en/docs/sidebar.yml` for section titles and page titles
```markdown
- title: Documentation
pages:
- title: Overview
- title: Basics
pages:
- title: Hello World
- title: Beyond The Basics
pages:
- title: Modules
```
4. Run `hugo server`
> 💡 Change `newsite/hugo.yaml` -> `enableGitInfo: false`, if you want to run `hugo server` before commit the changes.