Skip to content

helixml/docs

Repository files navigation

Helix Docs

Quick Start

Pre-requisites: Hugo, Go, Git and Node.

Launch the live server:

hugo serve

Update theme

hugo mod get -u
hugo mod tidy

See Update modules for more details.

CSS Notes

TL;DR; prefix all your colour-related tailwind classes with hx-.

The theme has a light-dark toggle, which is some custom javascript to tell all the theme's colour classes to switch to the dark.

Because I've also added raw tailwind to do custom tailwind stuff, it means that these classes don't get updated.

The net result is if you have a system preference of "dark", then set the manual toggle to "light", then the normal tailwind colours will be inverted.

The simplest workaround for now is to just prefix all tailwind colour classes with hx- which will then use the themes classes (which do work).

If you're wanting to use colours that don't exist in the theme, then you might have to add some javascript.

Deployment

The website is hosted by Netlify.

Other Notes

Base Template

This website is based upon Hextra.