hugo-starless
Code Issues

docs: simplify

Browse Source
This commit is contained in:
ruinivist
2026-06-22 20:26:33 +00:00
parent 66b9cdb0f3
commit 7918d8af9b
3 changed files with 19 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/docs/_index.md
+4 -3
View File
@@ -4,8 +4,9 @@ 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 explorer. That is the whole pitch.
hey hey!
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.
well, it's a simple there, inspired off of (quartz)[https://quartz.jzhao.xyz/] which I've been using for
the longest time with _way less_ bells and whistles and faster too ( cause hugo )
The rest of this section covers setup, the few things worth changing, and the files that actually matter.
Take a look at (how it looks)[fix this limk] and if you like what you see (install)[install]
content/docs/customize.md
+15
View File
@@ -4,6 +4,8 @@ summary = "Change the title, explorer, and footer strings first. Leave the rest
weight = 12
+++
## A few options are exposed
The fast path is to change four things in `hugo.toml`: `baseURL`, `title`, `params.sidebarFooter`, and `params.homeFooter`.
Then adjust `title` and `weight` in your content files. The sidebar explorer follows the section tree, so you do not need a special data file or a block for each page.
@@ -11,3 +13,16 @@ Then adjust `title` and `weight` in your content files. The sidebar explorer fol
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.
## but you can just modify the files directly...
The files that matter are not hard to find.
- `hugo.toml` sets the theme, site title, and footer text.
- `content/` holds the homepage and this short guide. Its section tree also drives the sidebar.
- `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/explorer-tree.html` renders the nested section and page 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.
content/docs/files.md
-16
View File
@@ -1,16 +0,0 @@
+++
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, and footer text.
- `content/` holds the homepage and this short guide. Its section tree also drives the sidebar.
- `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/explorer-tree.html` renders the nested section and page 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.