feat: README stuff
This commit is contained in:
daudix-UFO
247
README.md
247
README.md
@ -1,103 +1,144 @@
|
|||||||
# Duckquill
|
# Duckquill
|
||||||
|
|
||||||
[](https://nogithub.codeberg.page)
|
[](https://nogithub.codeberg.page)
|
||||||
[](https://ci.exozy.me/repos/159)
|
[](https://ci.exozy.me/repos/159)
|
||||||
|
|
||||||
[Duckquill](https://git.exozy.me/daudix/duckquill) is a modern, pretty, and clean (and very opinionated) [Zola](https://www.getzola.org) theme that has the purpose of greatly simplifying the process of rolling up your blog. It aims to provide all the needed options for comfortable writing, keeping the balance of it being simple.
|
[Duckquill](https://git.exozy.me/daudix/duckquill) is a modern, pretty, and clean (and very opinionated) [Zola](https://www.getzola.org) theme that has the purpose of greatly simplifying the process of rolling up your blog. It aims to provide all the needed options for comfortable writing, keeping the balance of it being simple.
|
||||||
|
|
||||||
[](https://i.imgur.com/1fCi1sF.png)
|
> Duckquill is made based on needs of [my website](https://daudix.exozy.me), if you need some feature/configuration that doesn't exist feel free to open an issue or better yet, pull request!
|
||||||
|
|
||||||
## Installation
|
[](https://i.imgur.com/1fCi1sF.png)
|
||||||
|
|
||||||
First, fork it and download this theme to your `themes` directory:
|
## Installation
|
||||||
|
|
||||||
```sh
|
First, download this theme to your `themes` directory:
|
||||||
git clone YOUR_FORK.git themes/duckquill
|
|
||||||
```
|
```sh
|
||||||
|
git clone https://git.exozy.me/daudix/duckquill.git themes/duckquill
|
||||||
...or add as submodule for easy updating (recommended if you already have git setup on site):
|
```
|
||||||
|
|
||||||
```sh
|
...or add as submodule for easy updating (recommended if you already have git setup on site):
|
||||||
git submodule init
|
|
||||||
git submodule add YOUR_FORK.git themes/duckquill
|
```sh
|
||||||
```
|
git submodule init
|
||||||
|
git submodule add https://git.exozy.me/daudix/duckquill.git themes/duckquill
|
||||||
and then enable it in your `config.toml`:
|
```
|
||||||
|
|
||||||
```
|
and then enable it in your `config.toml`:
|
||||||
theme = "duckquill"
|
|
||||||
```
|
```
|
||||||
|
theme = "duckquill"
|
||||||
## Options
|
```
|
||||||
|
|
||||||
Duckquill offers some configuration options to make it fit you better (but that doesn't make it less opinionated).
|
## Options
|
||||||
|
|
||||||
### Custom CSS
|
Duckquill offers some configuration options to make it fit you better (but that doesn't make it less opinionated).
|
||||||
|
|
||||||
You can add your own or override existing styles in the `themes/duckquill/sass/_custom.scss`, if for some reason overridden class are not respected, try using `!important`. This file is empty by default so you should not have issues with doing the `git pull` later.
|
### Custom CSS
|
||||||
|
|
||||||
### Accent color
|
You can add your own or override existing styles in the `sass/custom.scss` of your site, if for some reason overridden class are not respected, try using `!important`. You can import styles from Duckquill using `@use "../themes/duckquill/sass/NEEDED_FILE.scss";`.
|
||||||
|
|
||||||
Duckquill respects chosen accent color everywhere, you can use any HEX color code you want
|
### Accent color
|
||||||
|
|
||||||
First, change the accent color in `config.toml`:
|
Duckquill respects chosen accent color everywhere, you can use any HEX color code you want
|
||||||
|
|
||||||
```
|
First, change the accent color in `config.toml`:
|
||||||
[extra]
|
|
||||||
accent_color = "#HEX_COLOR_CODE"
|
```
|
||||||
```
|
[extra]
|
||||||
|
accent_color = "#HEX_COLOR_CODE"
|
||||||
Then, also change it in `themes/duckquill/sass/_variables.scss`:
|
```
|
||||||
|
|
||||||
```
|
Then, paste the following code inside `sass/custom.scss` (inside your site, not the theme):
|
||||||
$accent-color: #HEX_COLOR_CODE;
|
|
||||||
```
|
```
|
||||||
|
@use "sass:color";
|
||||||
### `[extra]` variables:
|
|
||||||
|
$accent-color: #HEX_COLOR_CODE;
|
||||||
- `accent_color`: Accent color used in some browsers set in metadata, for actual accent color see `themes/duckquill/sass/_variables.scss`
|
$accent-color-20: color.scale($accent-color, $alpha: -80%);
|
||||||
- `animated_favicon`: Specify if the favicon are animated GIF (true, false)
|
|
||||||
- `blog_title`: The title of the blog, used in `/blog`
|
$crt-bg: radial-gradient(
|
||||||
- `blog_description`: The description of the blog, displayed right under the blog title
|
color.scale($accent-color, $lightness: -80%),
|
||||||
- `date_format`: Allows setting custom date format in [Tera](https://keats.github.io/tera) format, all available variables are listed [here](https://docs.rs/chrono/0.4.31/chrono/format/strftime/index.html). Does not apply to comments
|
color.scale($accent-color, $lightness: -90%)
|
||||||
- `hosting`: Where the website source are located, used on 404 page
|
);
|
||||||
- `issues_url`: Link to site bug tracker, if present
|
|
||||||
- `source_url`: Link to site source (not built site)
|
$bg-l: color.mix($accent-color, rgb(250, 250, 250), 10%);
|
||||||
- `nav_links`: Links used in navigation bar
|
$bg-d: color.mix($accent-color, rgb(11, 11, 11), 5%);
|
||||||
|
|
||||||
The `nav_links` are set like so:
|
$glow:
|
||||||
|
0 0 0 1px color.scale($accent-color, $alpha: -95%),
|
||||||
```
|
0 2px 6px 2px color.scale($accent-color, $alpha: -95%),
|
||||||
[extra]
|
0 4px 24px 4px color.scale($accent-color, $alpha: -90%);
|
||||||
nav_links = [
|
|
||||||
{url = "https://example.org", name = "Example"},
|
:root {
|
||||||
{url = "https://mstdn.social", name = "Mastodon"},
|
--accent-color-20: #{$accent-color-20};
|
||||||
]
|
--accent-color: #{$accent-color};
|
||||||
```
|
--background: #{$bg-l};
|
||||||
|
--crt-bg: #{$crt-bg};
|
||||||
### `[extra.footer]` variables:
|
--glow: #{$glow};
|
||||||
|
}
|
||||||
- `johnvert_ref`: Site URL without `https://` part or trailing slashes, e.g `example.org`. Works only if `show_johnvert` are set to `true`
|
|
||||||
- `show_copyright`: Whether to display `© Duckquill, 2023`. (true, false)
|
@media (prefers-color-scheme: dark) {
|
||||||
- `show_johnvert`: Whether to display [Johnvertisement](https://john.citrons.xyz). (true, false)
|
:root {
|
||||||
- `show_powered_by`: Whether to display `Powered by Zola and Duckquill`. (true, false)
|
--background: #{$bg-d};
|
||||||
- `show_source`: Whether to display `Website source` link. (true, false)
|
}
|
||||||
|
}
|
||||||
### `[extra.comments]` variables:
|
```
|
||||||
|
|
||||||
- `host`: Mastodon home server, e.g `mstdn.social`
|
Set any color in `$accent-color` and reload, the accent color should be used now. This is a hack that is needed until Zola will be able to use `config.toml` inside Sass.
|
||||||
- `user`: Mastodon username, e.g `Daudix`
|
|
||||||
- `token`: Mastodon app token, e.g `jTNX9pAV8XEPBby0cPWF6CmGY60kkIy4vidggfxXmoQ`. Can be left empty, but in this case only first 60 comments will be loaded, instructions on how to get one are available [here](https://github.com/cassidyjames/cassidyjames.github.io/blob/47c449a0083113ea5be8d215beb6650ac64929e4/_config.yaml#L48-L52)
|
### `[extra]` variables:
|
||||||
|
|
||||||
## Test pages
|
- `accent_color`: Accent color used in some browsers set in metadata, see [#accent-color](https://git.exozy.me/daudix/duckquill#accent-color)
|
||||||
|
- `animated_favicon`: Specify if the favicon are animated GIF (true, false)
|
||||||
- [Demo page](https://duckquill.exozy.me/demo)
|
- `blog_title`: The title of the blog
|
||||||
- [Cake Party!](https://duckquill.exozy.me/demo/page)
|
- `blog_description`: The description of the blog, displayed right under the blog title
|
||||||
- [ActivityPub/Fediverse comments demo](https://duckquill.exozy.me/demo/comments)
|
- `date_format`: Allows setting custom date format in [Tera](https://keats.github.io/tera) format, all available variables are listed [here](https://docs.rs/chrono/0.4.31/chrono/format/strftime/index.html). Does not apply to comments
|
||||||
|
- `hosting`: Where the website source are located, used on 404 page
|
||||||
## Special thanks ♥
|
- `issues_url`: Link to site bug tracker, if present
|
||||||
|
- `source_url`: Link to site source (not built site)
|
||||||
- [Jakub Steiner](https://jimmac.eu) for an awesome [OS Component Website](https://jimmac.github.io/os-component-website), on top of which this whole thing is built
|
- `nav_links`: Links used in navigation bar
|
||||||
- [Cassidy James](https://cassidyjames.com) for an awesome [Mastodon-powered Comments](https://cassidyjames.com/blog/fediverse-blog-comments-mastodon)
|
|
||||||
- [Mehdi](https://codepen.io/meduzen) for an awesome [CSS Scanlines](https://codepen.io/meduzen/pen/zxbwRV)
|
The `nav_links` are set like so:
|
||||||
- dwb, ejm and jgs for awesome ASCII art
|
|
||||||
|
```
|
||||||
|
[extra]
|
||||||
|
nav_links = [
|
||||||
|
{url = "https://example.org", name = "Example"},
|
||||||
|
{url = "https://mstdn.social", name = "Mastodon"},
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
### `[extra.footer]` variables:
|
||||||
|
|
||||||
|
- `johnvert_ref`: Site URL without `https://` part or trailing slashes, e.g `example.org`. Works only if `show_johnvert` are set to `true`
|
||||||
|
- `show_copyright`: Whether to display `© Duckquill, 2023`. (true, false)
|
||||||
|
- `show_johnvert`: Whether to display [Johnvertisement](https://john.citrons.xyz). (true, false)
|
||||||
|
- `show_powered_by`: Whether to display `Powered by Zola and Duckquill`. (true, false)
|
||||||
|
- `show_source`: Whether to display `Website source` link. (true, false)
|
||||||
|
|
||||||
|
### `[extra.comments]` variables:
|
||||||
|
|
||||||
|
- `host`: Mastodon home server, e.g `mstdn.social`
|
||||||
|
- `user`: Mastodon username, e.g `Daudix`
|
||||||
|
- `token`: Mastodon app token, e.g `jTNX9pAV8XEPBby0cPWF6CmGY60kkIy4vidggfxXmoQ`. Can be left empty, but in this case only first 60 comments will be loaded, instructions on how to get one are available [here](https://github.com/cassidyjames/cassidyjames.github.io/blob/47c449a0083113ea5be8d215beb6650ac64929e4/_config.yaml#L48-L52)
|
||||||
|
|
||||||
|
These values are also used in the `<head>` for Mastodon verification.
|
||||||
|
|
||||||
|
## Test pages
|
||||||
|
|
||||||
|
- [Demo page](https://duckquill.exozy.me/demo)
|
||||||
|
- [Cake Party!](https://duckquill.exozy.me/demo/page)
|
||||||
|
- [ActivityPub/Fediverse comments demo](https://duckquill.exozy.me/demo/comments)
|
||||||
|
|
||||||
|
## Contribute
|
||||||
|
|
||||||
|
If you want to improve Duckquill in any way, feel free to open an issue, or even better, a pull request! I'm happy about every contribution!
|
||||||
|
|
||||||
|
## Special thanks ♥
|
||||||
|
|
||||||
|
- [Jakub Steiner](https://jimmac.eu) for an awesome [OS Component Website](https://jimmac.github.io/os-component-website), on top of which this whole thing is built
|
||||||
|
- [Cassidy James](https://cassidyjames.com) for an awesome [Mastodon-powered Comments](https://cassidyjames.com/blog/fediverse-blog-comments-mastodon)
|
||||||
|
- [Mehdi](https://codepen.io/meduzen) for an awesome [CSS Scanlines](https://codepen.io/meduzen/pen/zxbwRV)
|
||||||
|
- dwb, ejm and jgs for awesome ASCII art
|
||||||
|
- Everyone who supported me and said good stuff <3
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
@use "sass:color";
|
@use "sass:color";
|
||||||
|
|
||||||
$accent-color: #ffa348;
|
$accent-color: #ff7800;
|
||||||
$accent-color-20: color.scale($accent-color, $alpha: -80%);
|
$accent-color-20: color.scale($accent-color, $alpha: -80%);
|
||||||
|
|
||||||
$crt-bg: radial-gradient(
|
$crt-bg: radial-gradient(
|
||||||
|
|||||||
Reference in New Issue
Block a user