Skip to content

ejsdotsh/yacht-hugo-theme

Repository files navigation

YACHT — Another Custom Hugo Theme

When graduating from high school, I was voted "most likely to own a yacht" by my senior class. I don't think this is what they meant...

YACHT = YACHT Another Custom Hugo Theme

Build Status Latest Release License Hugo Catppuccin Contributors


What Is YACHT?

YACHT is a punny and recursively named theme for the Hugo static site generator which uses the Catppuccin Palettes and aims to be:

  • Simple
  • Mobile-first
  • Accessible
  • Responsive
  • Minimal external dependencies

Under Construction — this theme is sometimes being actively developed; breaking changes ahead

Getting Your Own YACHT

Once constructed, the preferred way of getting your own YACHT is by using Hugo Modules.

Please note that with the pending removal of the embedded libsass transpiler in Hugo, an external installion (not covered) of Dart Sass is required.

Requirements

  • Hugo ≥ 0.114.0
  • Go (for module management)
  • Dart Sass

Configuration

For config.toml:

[module]
[[module.imports]]
path = "github.com/ejsdotsh/yacht-hugo-theme"

[markup]
[markup.sass]
embed = false

For config.yaml:

module:
  imports:
    - path: "github.com/ejsdotsh/yacht-hugo-theme"
      disable: false

markup:
  sass:
    embed: false

Then run:

hugo mod get -u ./...

References & Inspiration

This theme draws inspiration from:

Contributing

Contributions are welcome; please open an Issue describing the fix/change, and link a Pull Request.

  • Fork the repository
  • Create your feature branch (git checkout -b feature/AmazingFeature)
  • Commit your changes (git commit -m 'Add some AmazingFeature')
  • Push to the branch (git push origin feature/AmazingFeature)
  • Open a Pull Request and link to Issue

License

This project is licensed under the MPL-2.0 License — see the LICENSE file for details.

Made with ❤️ by e.j. sahala

Packages

 
 
 

Contributors