docs: refresh copy
This commit is contained in:
+3
-7
@@ -2,12 +2,8 @@
|
||||
title = "Starless"
|
||||
+++
|
||||
|
||||
Starless is a small Hugo theme for dark, text first sites.
|
||||
hey hey!
|
||||
|
||||
I built it to keep one shape and get out of the way: a left rail, a narrow reading column, and simple navigation.
|
||||
this is a theme 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)
|
||||
|
||||
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.
|
||||
Take a look at [how it looks](/docs/how-it-looks/) and if you like what you see, [install it](/docs/install/).
|
||||
|
||||
@@ -1,12 +1,7 @@
|
||||
+++
|
||||
title = "Guide"
|
||||
summary = "The short version of what Starless gives you and what it skips."
|
||||
title = "Docs"
|
||||
summary = "Install, customize, and preview the theme."
|
||||
weight = 10
|
||||
+++
|
||||
|
||||
hey hey!
|
||||
|
||||
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 )
|
||||
|
||||
Take a look at (how it looks)[fix this limk] and if you like what you see (install)[install]
|
||||
The homepage is the quick pitch. The pages below are the parts you might actually need.
|
||||
|
||||
+26
-13
@@ -6,23 +6,36 @@ 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`.
|
||||
```toml
|
||||
# site url
|
||||
baseURL = "https://example.org/"
|
||||
|
||||
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.
|
||||
# language
|
||||
locale = "en-us"
|
||||
|
||||
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`.
|
||||
# sidebar + page title
|
||||
title = "starless"
|
||||
|
||||
That is enough for most forks. The theme stays easier to live with if you change one obvious file at a time.
|
||||
# theme
|
||||
theme = "starless"
|
||||
|
||||
## but you can just modify the files directly...
|
||||
[params]
|
||||
# meta description
|
||||
description = "Starless is a small Hugo theme for dark, text first sites."
|
||||
|
||||
The files that matter are not hard to find.
|
||||
# sidebar footer
|
||||
sidebarFooter = "built with Hugo"
|
||||
|
||||
- `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.
|
||||
# page footer
|
||||
homeFooter = "see you in another file!"
|
||||
```
|
||||
|
||||
If you are trying to understand the theme, read those files in that order. There is not much else hiding off to the side.
|
||||
## or just modify files
|
||||
|
||||
- `hugo.toml`: config file for some of the stuff ( as above )
|
||||
- `content/`: your blog content goes here
|
||||
- `themes/starless/layouts/_default/baseof.html`: base html file for the core layout, search, and shared stuff
|
||||
- `themes/starless/assets/css/starless.css`: css file for the theme styles, the color tokens are defined at the top
|
||||
- `themes/starless/layouts/partials/sidebar.html`: sidebar layout file
|
||||
- `themes/starless/layouts/partials/explorer-tree.html`: file for the nested sidebar links
|
||||
- `themes/starless/layouts/_default/home.html`, `list.html`, `single.html`: layout files for the different page types
|
||||
|
||||
@@ -38,7 +38,7 @@ console.log(total);
|
||||
|
||||
```toml
|
||||
[params]
|
||||
description = "Small on purpose."
|
||||
theme = "starless"
|
||||
```
|
||||
|
||||
## Math
|
||||
@@ -68,6 +68,8 @@ $$
|
||||
| Strong text | `**bold**` | **bold** |
|
||||
| Emphasis | `*italic*` | _italic_ |
|
||||
|
||||
---
|
||||
|
||||
## Lists
|
||||
|
||||
1. First ordered item
|
||||
@@ -82,11 +84,3 @@ $$
|
||||
|
||||
- [x] Task item done
|
||||
- [ ] Task item open
|
||||
|
||||
## Rule
|
||||
|
||||
Text before the rule.
|
||||
|
||||
---
|
||||
|
||||
Text after the rule.
|
||||
|
||||
Reference in New Issue
Block a user