Compare commits

...

19 commits

Author SHA1 Message Date
a8ee1a7415
Fixed the kaputt footer 2025-02-20 15:38:07 +01:00
Joe Roe
0e8229d9e2
Bump to 0.4.0 2024-02-12 10:00:22 +01:00
Joe Roe
d440b668cd
Update installation instructions 2024-02-12 09:56:56 +01:00
Joe Roe
188903ac09
Document colour classes 2024-02-12 09:43:53 +01:00
Joe Roe
e81c2f02ed
Add colours to README 2024-02-12 09:37:23 +01:00
Joe Roe
0d8a9293e6
Add 'features' to README 2024-02-12 09:27:00 +01:00
Joe Roe
604dbed074
Remove unused element 2024-02-12 09:19:26 +01:00
Joe Roe
178586f0a0
Update NEWS 2024-02-12 09:16:39 +01:00
Joe Roe
0795b95597
Add TOC to example post 2024-02-12 09:12:52 +01:00
Joe Roe
eb627f6a6c
Merge pull request #51 from dasvh/addFeatureStickyAsideCSS
Add feature sticky aside css
2024-02-12 09:12:28 +01:00
dario
6100fae45c added CSS to accommodate larger table of contents in the aside section 2023-05-05 21:49:14 +02:00
dasvh
53e002d56e
Merge pull request #5 from dasvh/fixedSidebarTest
adjusted css for sidebar scroll behaviour
2023-05-05 20:48:11 +02:00
dario
d02e1eb85a adjusted css for sidebar scroll behaviour 2023-05-05 20:36:43 +02:00
dasvh
a2a65aa3b4
Merge pull request #4 from dasvh/fixedSidebarTest
add scrolling functionality to the .aside
2023-05-05 17:43:53 +02:00
dario
e726071f17 add scrolling functionality to the .aside 2023-05-05 17:41:21 +02:00
dasvh
d2fa839098
Merge pull request #3 from dasvh/fixedSidebarTest
table of content is now in a fixed position when you scroll the page
2023-05-05 17:26:38 +02:00
dario
ce620a06e1 changed layout.css for toc to stay fixed 2023-05-05 17:24:24 +02:00
dasvh
fdb2e5fb9f
Merge branch 'joeroe:main' into main 2023-05-05 16:18:29 +02:00
dasvh
b1153e8b89
Merge pull request #2 from dasvh/1-adding-a-table-of-contents
adding a table of contents
2023-05-01 08:46:11 +02:00
8 changed files with 97 additions and 44 deletions

13
NEWS.md
View file

@ -1,7 +1,16 @@
# risotto (development version)
* Fix overflow of code blocks with line numbers (#41)
* Add descriptions to sidebar of list pages, where defined in the frontmatter of `_index.md` (#55)
# risotto 0.4.0
* Added descriptions to sidebar of list pages, where defined in the frontmatter of `_index.md` (#55)
* Made sidebar sticky, avoiding overflow for long tables of contents (#51)
* Added convenience classes for colours, e.g. `.base00` and `.bg-base00`.
* Fixed overflow of code blocks with line numbers (#41)
* Fixed invalid HTML in page header (#64)
* Updated FontAwesome to 6.5.1 (#63)
* Please note that future versions will probably not include FontAwesome by default
* Updated Academicons to 1.9.4 (#63)
* Please note that future versions will probably not include Academicons by default
# risotto 0.3.0

View file

@ -10,19 +10,25 @@ risotto is a minimalist, responsive [hugo](https://gohugo.io) theme inspired by
![Screenshot of the risotto theme](https://raw.githubusercontent.com/joeroe/risotto/master/images/screenshot.png)
## Features
* Plain, semantic HTML with no Javascript
* Plain CSS no frameworks, no preprocessors, just simple and easy-to-customise stylesheets
* Uses [CSS Grid](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_grid_layout) for native responsive behaviour without arbitrary breakpoints
* Comes with [16 built-in colour schemes](#colour-schemes) based on popular terminal themes plus the ability to use custom themes using the [base16 system](https://github.com/monicfenga/base16-styles)
## Install
The easiest way to install the theme is to clone this repository into your site's `themes` directory:
The easiest way to install the theme is to [download the latest release](https://github.com/joeroe/risotto/releases/tag/release) and extract it to your project's `themes/` directory.
You can also clone this repository into your site's `themes` directory and checkout the latest release:
```shell
git clone https://github.com/joeroe/risotto themes/risotto
git clone https://github.com/joeroe/risotto themes/risotto && cd themes/risotto
rit checkout $(git tag -l | grep '^v[0-9.]*$' | sort -V | tail -n 1)
```
If your site is already a git repository, you can add the theme as a submodule instead:
```shell
git submodule add https://github.com/joeroe/risotto.git themes/risotto
```
Note that this will not work if your site is itself a git repository.
In that case, you can add the theme as a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules), but this is not recommended due to the difficulty of tracking a specific release.
## Update
@ -33,19 +39,15 @@ cd themes/risotto
git pull
```
Or, if you added it as a git submodule:
```shell
git submodule update --remote
```
Otherwise, simply [download the latest release](https://github.com/joeroe/risotto/releases/tag/release) and extract it to your project's `themes/` directory, replacing the old version.
## Configure
To use the theme, add `theme = 'risotto'` to your site's `config.toml`, or `theme: risotto` to your `config.yaml` respectively.
To use the theme, add `theme = 'risotto'` to your site's `config.toml`, or `theme: risotto` to your `config.yaml`.
See `exampleSite/config.toml` for the theme-specific parameters you need to add to your site's `config.toml` or `config.yaml` to configure the theme.
### Colour palettes
### Colour schemes
risotto uses the [base16 framework](https://github.com/chriskempson/base16) to define colour schemes that can be used with the `theme.palette` parameter.
A selection of 16 palettes (10 dark, 6 light) are bundled with the theme: `apprentice`, `base16-dark`, `base16-light`, `dracula`, `gruvbox-dark`, `gruvbox-light`, `material`, `papercolor-dark`, `papercolor-light`, `solarized-dark`, `solarized-light`, `tender`, `tokyo-night-dark`, `tokyo-night-light`, `windows-95` and `windows-95-light`.
@ -57,28 +59,36 @@ The easiest way to use other base16 styles is to place .css file from https://gi
Or to define a wholly custom theme, you will need to define the following CSS variables for the following base16 colours (see [base16-dark.css](blob/main/static/css/palettes/base16-dark.css) for an example):
| Base | Default colour | Used for | Examples |
| ---- | -------------- | -------- | -------- |
| 00 | Dark | Background | Page background |
| 01 | │ | Alt. background | Content background |
| 02 | | In-text backgrounds | `<pre>`, `<code>`, `<kbd>`, `<samp>` |
| 03 | │ | Muted text | `:before` & `:marker` symbols |
| 04 | │ | Alt. foreground | Aside text |
| 05 | │ | Foreground | Content text |
| 06 | │ | | |
| 07 | Light | | |
| 08 | Red | | |
| 09 | Orange | | |
| 0A | Yellow | Highlights | Selected text, `<mark>` |
| 0B | Green | Primary accent | Logo |
| 0C | Cyan | Active links | `a:active`, `a:hover` |
| 0D | Blue | Links | `a:link`, `a:visited` |
| 0E | Magenta | | |
| 0F | Brown | | |
| Base | Default colour | Used for | Examples |
| ---- | ------------------------------------------ | ------------------- | ------------------------------------ |
| 00 | <span class="base00">Dark</span> | Background | Page background |
| 01 | <span class="base01"></span> | Alt. background | Content background |
| 02 | <span class="base02"></span> | In-text backgrounds | `<pre>`, `<code>`, `<kbd>`, `<samp>` |
| 03 | <span class="base03"></span> | Muted text | `:before` & `:marker` symbols |
| 04 | <span class="base04"></span> | Alt. foreground | Aside text |
| 05 | <span class="base05"></span> | Foreground | Content text |
| 06 | <span class="base06"></span> | | |
| 07 | <span class="base07">Light</span> | | |
| 08 | <span class="base08">Red</span> | | |
| 09 | <span class="base09">Orange</span> | | |
| 0A | <span class="base0A">Yellow</span> | Highlights | Selected text, `<mark>` |
| 0B | <span class="base0B">Green</span> | Primary accent | Logo |
| 0C | <span class="base0C">Cyan</span> | Active links | `a:active`, `a:hover` |
| 0D | <span class="base0D">Blue</span> | Links | `a:link`, `a:visited` |
| 0E | <span class="base0E">Magenta</span> | | |
| 0F | <span class="base0F">Brown</span> | | |
For light mode palettes, the sequence of 0007 should be reversed (light to dark, not dark to light).
Note that not all colours are currently used in the theme.
You you use these colours directly in content using the convenience classes `.baseXX` and `.bg-baseXX`.
For example:
```html
<span class="base0A">Yellow text</span>
<mark class="base0D">Text highlighted in green</mark>
```
## Favicon
risotto will automatically use favicons placed in the `static/` directory.

View file

@ -14,6 +14,7 @@ categories = [
]
series = ["Themes Guide"]
aliases = ["migrate-from-jekyl"]
toc = true
+++
This article offers a sample of basic Markdown syntax that can be used in Hugo content files, also it shows whether basic HTML elements are decorated with CSS in a Hugo theme.

View file

@ -2,10 +2,6 @@
<header class="content__header">
<h1>{{ .Title | markdownify }}</h1>
</header>
{{ if .Params.toc }}
<aside>
</aside>
{{ end }}
<div class="content__body">
{{ .Content }}
</div>

View file

@ -1,3 +1,2 @@
{{- partial "lang.html" . -}}
<p class="copyright">{{ .Site.Copyright | markdownify }}</p>
<p class="advertisement">Powered by <a href="https://gohugo.io/">hugo</a> and <a href="https://github.com/joeroe/risotto">risotto</a>.</p>

View file

@ -49,6 +49,11 @@
.page__aside {
grid-area: aside;
color: var(--off-fg);
position: sticky;
top: 1rem;
right: 1rem;
overflow-y: auto;
max-height: 95vh;
}
/* Footer */

View file

@ -219,3 +219,37 @@ img {
height: auto;
}
/* Colour classes */
.base00 { color: var(--base00); }
.base01 { color: var(--base01); }
.base02 { color: var(--base02); }
.base03 { color: var(--base03); }
.base04 { color: var(--base04); }
.base05 { color: var(--base05); }
.base06 { color: var(--base06); }
.base07 { color: var(--base07); }
.base08 { color: var(--base08); }
.base09 { color: var(--base09); }
.base0A { color: var(--base0A); }
.base0B { color: var(--base0B); }
.base0C { color: var(--base0C); }
.base0D { color: var(--base0D); }
.base0E { color: var(--base0E); }
.base0F { color: var(--base0F); }
.bg-base00 { background-color: var(--base00); }
.bg-base01 { background-color: var(--base01); }
.bg-base02 { background-color: var(--base02); }
.bg-base03 { background-color: var(--base03); }
.bg-base04 { background-color: var(--base04); }
.bg-base05 { background-color: var(--base05); }
.bg-base06 { background-color: var(--base06); }
.bg-base07 { background-color: var(--base07); }
.bg-base08 { background-color: var(--base08); }
.bg-base09 { background-color: var(--base09); }
.bg-base0A { background-color: var(--base0A); }
.bg-base0B { background-color: var(--base0B); }
.bg-base0C { background-color: var(--base0C); }
.bg-base0D { background-color: var(--base0D); }
.bg-base0E { background-color: var(--base0E); }
.bg-base0F { background-color: var(--base0F); }

View file

@ -8,7 +8,6 @@ demosite = "https://risotto.joeroe.io"
tags = ["responsive", "minimal", "dark mode"]
features = []
min_version = "0.41.0"
[author]
name = "Joe Roe"