website/themes/serene/README.md

32 lines
977 B
Markdown

<img width="1501" alt="screenshot" src="https://github.com/isunjn/serene/assets/60461730/33516366-3670-497f-bd72-41ebe8f06f1a">
<br /><br />
A blog theme for [zola](https://www.getzola.org), simple and clean
## Demo
- <https://serene-demo-site.vercel.app>
## Features
- A spiffy design, well crafted
- Projects page
- Dark mode
- Image zooming
- Out-of-date alert
- Sticky table-of-contents
- Callouts (note, warning, alert, etc.)
- Comments using [Giscus](https://giscus.app)
- Mathematical notations using [KaTeX](https://katex.org)
- Diagrams and visualizations using [Mermaid](https://github.com/mermaid-js/mermaid)
## Usage
- Check the [USAGE.md](https://github.com/isunjn/serene/blob/latest/USAGE.md) of `latest` branch
- Also available in Simplified Chinese: [USAGE-zh_CN.md](https://github.com/isunjn/serene/blob/latest/USAGE-zh_CN.md) (简体中文)
## Contributing
- Before you make any non-trivial changes, you may want to open an issue so we can discuss