/yggdrasill

A minimal theme for Hugo

Primary LanguageSCSSMIT LicenseMIT

Yggdrasill

A minimal theme for Hugo.

⚠︎ Work in Progress ⚠︎

Please visit https://yggdrasill.rudeigerc.dev for the latest demo of the theme. The theme is under development and the styles may not remain the same.

The design is partially inspired by:

Installation

Install with Hugo Modules

# Initialize the Hugo module system
$ hugo mod init github.com/<your_user>/<your_project>

In config.toml:

theme = "github.com/rudeigerc/yggdrasill"

# Import the theme
[module]
[[module.imports]]
  path = "github.com/rudeigerc/yggdrasill"

Please refer to the Hugo documentation for more information about installation with Hugo modules.

Install with Git Submodules

$ git submodule add https://github.com/rudeigerc/yggdrasill themes/yggdrasill

In config.toml:

theme = "yggdrasill"

Update

Update with Hugo Modules

$ hugo mod get -u github.com/rudeigerc/yggdrasill

Update with Git Submodules

$ git submodule update --remote

Development

Yggdrasill uses pnpm as the package manager for development, mostly for linting and formatting.

$ pnpm install

License

Yggdrasill is licensed under the MIT License.