updated README
This commit is contained in:
33
README.md
33
README.md
@@ -26,6 +26,22 @@ git clone https://github.com/Speyll/anemone
|
||||
theme = "anemone"
|
||||
```
|
||||
|
||||
## Release Notes
|
||||
|
||||
#### 02-03-2024
|
||||
This release brings several improvements and enhancements, focusing mainly on optimizing performance and user experience. Here's a summary of the key changes:
|
||||
|
||||
- **suCSS Integration:** The core CSS now leverages the lightweight [suCSS framework](https://speyll.github.io/suCSS/) made by yours truly, providing better maintainability, robustness, and scalability. With suCSS, the theme should maintain consistent appearance across different browsers.
|
||||
|
||||
- **Enhanced Theme Toggle:** The dark and light theme toggle has been revamped for more consistency. Now, the website respects the user's system-wide theme settings, ensuring a seamless experience. Additionally, the toggle retains the selected theme for future visits, offering improved usability.
|
||||
|
||||
- **Smooth Transition and Sound Effect:** Enjoy a smoother transition between the dark and light mode accompanied by a subtle sound effect. Rest assured, the added sound effect incurs minimal performance overhead, with the file size being just 1kb.
|
||||
|
||||
- **Class Names and Shortcodes Update:** Some class names and shortcodes have been modified for better organization and clarity. I apologize for any inconvenience this may cause.
|
||||
|
||||
- **Slight change in Color Choice:** Some dark mode colors have been changed for the sake of readability, still using [veqev](https://github.com/Speyll/veqev).
|
||||
|
||||
|
||||
### Options
|
||||
|
||||
Anemone provides various options to customize your website:
|
||||
@@ -74,13 +90,13 @@ header_nav = [
|
||||
]
|
||||
```
|
||||
|
||||
#### Default Theme
|
||||
#### Add Table of Contents (TOC) to Pages
|
||||
|
||||
To configure the default theme, simply utilize the `default_theme` variable and set it to either `light` or `dark`:
|
||||
In a page's frontmatter, set `extra.toc` to `true`:
|
||||
|
||||
```toml
|
||||
[extra]
|
||||
default_theme = "light"
|
||||
toc = true
|
||||
```
|
||||
|
||||
#### Display Author Name in Blog Posts
|
||||
@@ -100,18 +116,9 @@ Add a webring with a shortcode:
|
||||
{{ webring(prev="#", webring="#", webringName="Random Webring", next="#") }}
|
||||
```
|
||||
|
||||
#### Add Table of Contents (TOC) to Pages
|
||||
|
||||
In a page's frontmatter, set `extra.toc` to `true`:
|
||||
|
||||
```toml
|
||||
[extra]
|
||||
toc = true
|
||||
```
|
||||
|
||||
### Extra Data
|
||||
|
||||
- Set the `author` in both the main config and in pages' metadata.
|
||||
- Set the `author` in both the main config and in pages metadata.
|
||||
- Use the `image` variable in pages to add an image to HTML `<meta>` tags.
|
||||
- Similarly, set `favicon` in the main config, and it will be used as the site icon.
|
||||
- Set `footer_content_license` and `footer_content_license_link` if you wish to display content license information in the footer.
|
||||
|
||||
Reference in New Issue
Block a user