feat: initial style
This commit is contained in:
@@ -0,0 +1,13 @@
|
||||
+++
|
||||
title = "Starless"
|
||||
+++
|
||||
|
||||
Starless is a small Hugo theme for dark, text first sites.
|
||||
|
||||
I built it to keep one shape and get out of the way: a left rail, a narrow reading column, and simple navigation.
|
||||
|
||||
There is no asset pipeline here. No client side framework either. Just Hugo templates and enough styling to hold the page together.
|
||||
|
||||
This site is both the demo and the docs. If something feels too clever, it probably does not belong in the theme.
|
||||
|
||||
Start with the guide if you want to use it. It is short on purpose.
|
||||
@@ -0,0 +1,11 @@
|
||||
+++
|
||||
title = "Guide"
|
||||
summary = "The short version of what Starless gives you and what it skips."
|
||||
weight = 10
|
||||
+++
|
||||
|
||||
Starless gives you a homepage, section pages, single pages, and a sidebar menu. That is the whole pitch.
|
||||
|
||||
It is meant for people who want a dark shell and plain content, not a huge pile of options. If you want every part configurable from front matter, you will outgrow this fast.
|
||||
|
||||
The rest of this section covers setup, the few things worth changing, and the files that actually matter.
|
||||
@@ -0,0 +1,13 @@
|
||||
+++
|
||||
title = "Customize"
|
||||
summary = "Change the title, menu, and footer strings first. Leave the rest alone until it bothers you."
|
||||
weight = 12
|
||||
+++
|
||||
|
||||
The fast path is to change four things in `hugo.toml`: `baseURL`, `title`, `params.sidebarFooter`, and `params.homeFooter`.
|
||||
|
||||
Then adjust `menus.main`. The sidebar shape comes from the menu, so you do not need a special data file or extra config layer.
|
||||
|
||||
If you want a different voice on the homepage, edit `content/_index.md`. If you want layout changes, start in `themes/starless/layouts/_default/baseof.html`.
|
||||
|
||||
That is enough for most forks. The theme stays easier to live with if you change one obvious file at a time.
|
||||
@@ -0,0 +1,16 @@
|
||||
+++
|
||||
title = "Files"
|
||||
summary = "The theme is small enough that you can learn it in one pass."
|
||||
weight = 13
|
||||
+++
|
||||
|
||||
The files that matter are not hard to find.
|
||||
|
||||
- `hugo.toml` sets the theme, site title, footer text, and sidebar menu.
|
||||
- `content/` holds the homepage and this short guide.
|
||||
- `themes/starless/layouts/_default/baseof.html` builds the page shell and the shared styling.
|
||||
- `themes/starless/layouts/partials/sidebar.html` renders the left rail.
|
||||
- `themes/starless/layouts/partials/menu-tree.html` renders the nested menu links.
|
||||
- `themes/starless/layouts/_default/home.html`, `list.html`, and `single.html` handle the main content area.
|
||||
|
||||
If you are trying to understand the theme, read those files in that order. There is not much else hiding off to the side.
|
||||
@@ -0,0 +1,13 @@
|
||||
+++
|
||||
title = "Install"
|
||||
summary = "Start a Hugo site, copy the theme, and point the config at it."
|
||||
weight = 11
|
||||
+++
|
||||
|
||||
If you fork this repo, you already have the theme and the demo site in one place.
|
||||
|
||||
If you want to drop Starless into another Hugo site, copy the `themes/starless/` folder into that project and set `theme = "starless"` in `hugo.toml`.
|
||||
|
||||
After that, add a small `menus.main` block so the sidebar has something to render. The current config in this repo is enough to copy and trim.
|
||||
|
||||
Run `hugo server` and edit from there. The theme is simple enough that most changes show up where you expect.
|
||||
Reference in New Issue
Block a user