tiskifer-theme/README.md
2023-02-05 22:00:05 +01:00

67 lines
1.7 KiB
Markdown

# Tiskifer Theme
Originaly forked from [Shadharon](https://syedzayyan.github.io/shadharon).
<details open>
<summary>Dark theme</summary>
![blog-dark](https://raw.githubusercontent.com/syedzayyan/shadharon/main/screenshot.png)
</details>
<details close>
<summary>Light theme</summary>
![light-dark](https://raw.githubusercontent.com/syedzayyan/shadharon/main/screenshot-light.png)
</details>
## Features
- [X] Themes (light, dark). Default theme is dark with a switcher in the navbar
- [X] Projects page
- [x] Social Links
- [x] Tags
## Installation
0. Initialize Git Repo if not initialized
1. Download the theme
```
git submodule add https://git.sr.ht/~koehr/tiskifer-theme themes/tiskifer
```
2. Add `theme = "tiskifer"` to your `config.toml`
3. Copy the example content
```
cp -R themes/tiskifer/content/. content
```
## Customization
1. For customization refer to config.toml files, which has comments.
2. For customizing the banner on the homepage the content/posts/_index.md needs modification. The desc variable under `extra`, specifically. You could delete this as well to remove banner. For an about page or any aditional page an .md file in the "content" directory will do.
You can add stylesheets to override the theme:
```toml
[extra]
stylesheets = [
"override.css",
]
```
These filenames are relative to the root of the site. In this example, the two CSS files would be in the `static` folder.
## References
This theme is a fork of
[Shadharon](https://syedzayyan.github.io/shadharon)
which originally takes inspiration from
- [apollo](https://github.com/not-matthias/apollo).
- [Tania's Website](https://tania.dev/)
- [Anpu Zola Theme](https://github.com/zbrox/anpu-zola-theme)