mirror of
https://github.com/gohugoio/hugo.git
synced 2024-12-01 14:29:12 -05:00
5fd1e74903
``` git subtree add --prefix=docs/ https://github.com/gohugoio/hugoDocs.git master --squash ``` Closes #11925
29 lines
1.3 KiB
Markdown
29 lines
1.3 KiB
Markdown
---
|
||
title: Hugo Modules
|
||
linkTitle: Overview
|
||
description: How to use Hugo Modules.
|
||
categories: []
|
||
keywords: []
|
||
menu:
|
||
docs:
|
||
identifier: hugo-modules-overview
|
||
parent: modules
|
||
weight: 10
|
||
weight: 10
|
||
toc: true
|
||
aliases: [/themes/overview/,/themes/]
|
||
---
|
||
|
||
**Hugo Modules** are the core building blocks in Hugo. A _module_ can be your main project or a smaller module providing one or more of the 7 component types defined in Hugo: **static**, **content**, **layouts**, **data**, **assets**, **i18n**, and **archetypes**.
|
||
|
||
You can combine modules in any combination you like, and even mount directories from non-Hugo projects, forming a big, virtual union file system.
|
||
|
||
Hugo Modules are powered by Go Modules. For more information about Go Modules, see:
|
||
|
||
- [https://github.com/golang/go/wiki/Modules](https://github.com/golang/go/wiki/Modules)
|
||
- [https://go.dev/blog/using-go-modules](https://go.dev/blog/using-go-modules)
|
||
|
||
Some example projects:
|
||
|
||
- [https://github.com/bep/docuapi](https://github.com/bep/docuapi) is a theme that has been ported to Hugo Modules while testing this feature. It is a good example of a non-Hugo-project mounted into Hugo’s folder structure. It even shows a JS Bundler implementation in regular Go templates.
|
||
- [https://github.com/bep/my-modular-site](https://github.com/bep/my-modular-site) is a very simple site used for testing.
|