reivilibre/mirror-zola
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update themes gallery (#1887)

Browse Source 
Co-authored-by: GitHub Action <action@github.com>
This commit is contained in:
Vincent Prouillet 2022-06-06 10:46:29 +02:00 committed by GitHub
parent aff5bff0a6
commit 294505f4bc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
64 changed files with 991 additions and 322 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

101
docs/content/themes/DeepThought/index.md
View File

@ -3,14 +3,14 @@
title = "DeepThought"
description = "A simple blog theme focused on writing powered by Bulma and Zola."
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/RatanShreshtha/DeepThought.git"
homepage = "https://github.com/RatanShreshtha/DeepThought"
minimum_version = "0.9.0"
minimum_version = "0.14.1"
license = "MIT"
demo = "https://deepthought-theme.netlify.app/"
@ -65,8 +65,6 @@ homepage = "https://ratanshreshtha.dev"
</ol>
</details>
## About The Project
[![DeepThought](./screenshot.png)](https://deepthought-theme.netlify.app/)
@ -74,6 +72,7 @@ homepage = "https://ratanshreshtha.dev"
> A simple blog theme focused on writing powered by Bulma and Zola.
### Features
- [x] Dark Mode
- [x] Pagination
- [x] Search
@ -88,13 +87,10 @@ homepage = "https://ratanshreshtha.dev"
- [x] Multilingual Navbar
- [x] Katex
### Built With
* [Zola](https://www.getzola.org/)
* [Bulma](https://bulma.io/)
- [Zola](https://www.getzola.org/)
- [Bulma](https://bulma.io/)
## Getting Started
@ -110,22 +106,32 @@ Follow zola's guide on [installing a theme](https://www.getzola.org/documentatio
Make sure to add `theme = "DeepThought"` to your `config.toml`
**Check zola version (only 0.9.0+)**
Just to double-check to make sure you have the right version. It is not supported to use this theme with a version under 0.9.0.
Just to double-check to make sure you have the right version. It is not supported to use this theme with a version under 0.14.1.
## Usage
### How to serve?
Go into your sites directory and type `zola serve`. You should see your new site at `localhost:1111`.
**NOTE**: you must provide the theme options variables in `config.toml` to serve a functioning site
**NOTE**: you must provide the theme options variables in `config.toml` to serve a functioning site
### Deployment
[Zola](https://www.getzola.org) already has great documentation for deploying to [Netlify](https://www.getzola.org/documentation/deployment/netlify/) or [Github Pages](https://www.getzola.org/documentation/deployment/github-pages/). I won't bore you with a regurgitated explanation.
### Theme Options
```toml
# Enable external libraries
[extra]
katex.enabled = true
katex.auto_render = true
chart.enabled = true
mermaid.enabled = true
galleria.enabled = true
navbar_items = [
{ code = "en", nav_items = [
{ url = "$BASE_URL/", name = "Home" },
@ -159,8 +165,11 @@ keybase = "<keybase_username>"
linkedin = "<linkedin_username>"
stackoverflow = "<stackoverflow_userid>"
twitter = "<twitter_username>"
instagram = "<instagram_usernaem>"
instagram = "<instagram_username>"
behance = "<behance_username>"
google_scholar = "<googlescholar_userid>"
orcid = "<orcid_userid>"
mastodon = "<mastadon_username>"
# To add google analytics
@ -173,6 +182,7 @@ disqus = "<your_disqus_shortname>"
# To enable mapbox maps
[extra.mapbox]
enabled = true
access_token = "<your_access_token>"
```
@ -184,7 +194,7 @@ If you want to have a multilingual navbar on your blog, you must add your new co
```toml
languages = [
{code = "fr"},
{code = "fr"},
{code = "es"},
]
```
@ -220,46 +230,52 @@ fr:
![DeepThought](./screenshot_navbar_fr.png)
es:
es:
![DeepThought](./screenshot_navbar_es.png)
### KaTeX math formula support
This theme contains math formula support using [KaTeX](https://katex.org/),
which can be enabled by setting `katex.enabled = true` in the `extra` section
+of `config.toml`:
```toml
[extra]
katex.enabled = true
katex.auto_render = true
```
of `config.toml`.
After enabling this extension, the `katex` short code can be used in documents:
* `{{/* katex(body="\KaTeX") */}}` to typeset a math formula inlined into a text,
- `{{/* katex(body="\KaTeX") */}}` to typeset a math formula inlined into a text,
similar to `$...$` in LaTeX
* `{%/* katex(block=true) */%}\KaTeX{%/* end */%}` to typeset a block of math formulas,
- `{%/* katex(block=true) */%}\KaTeX{%/* end */%}` to typeset a block of math formulas,
similar to `$$...$$` in LaTeX
#### Automatic rendering without short codes
Optionally, `\\( \KaTeX \\)` / `$ \KaTeX $` inline and `\\[ \KaTeX \\]` / `$$ \KaTeX $$`
block-style automatic rendering is also supported, if enabled in the config:
block-style automatic rendering is also supported, if enabled in the config
by setting `katex.auto_render = true`.
```toml
[extra]
katex.enabled = true
katex.auto_render = true
### Elasticlunr search in other language
Zola use [Elasticlunr.js](https://github.com/weixsong/elasticlunr.js) to add full-text search feature.
To use languages other than en (English), you need to add some javascript files. See the Zola's issue [#1349](https://github.com/getzola/zola/issues/1349).
By placing the `templates/base.html`on your project and using the `other_lang_search_js` block, you can load the required additional javascript files in the right timing.
e.g. `templates/base.html`
```html
{%/* extends "DeepThought/templates/base.html" */%} {%/* block other_lang_search_js */%}
<script src="{{/* get_url(path='js/lunr.stemmer.support.js') */}}"></script>
<script src="{{/* get_url(path='js/tinyseg.js') */}}"></script>
<script src="{{/* get_url(path='js/lunr.' ~ lang ~ '.js') */}}"></script>
<script src="{{/* get_url(path='js/search.js') */}}"></script>
{%/* endblock */%}
```
More detailed explanations are aound in [elasticlunr's documents](https://github.com/weixsong/elasticlunr.js#other-languages-example-in-browser).
## Roadmap
See the [open issues](https://github.com/RatanShreshtha/DeepThought/issues) for a list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
@ -270,27 +286,22 @@ Contributions are what make the open source community such an amazing place to b
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
Ratan Kulshreshtha - [@RatanShreshtha](https://twitter.com/RatanShreshtha)>
Project Link: [https://github.com/RatanShreshtha/DeepThought](https://github.com/RatanShreshtha/DeepThought)
## Acknowledgements
* [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
* [Choose an Open Source License](https://choosealicense.com)
* [Slick Carousel](https://kenwheeler.github.io/slick)
* [Font Awesome](https://fontawesome.com)
* [Unsplash](https://unsplash.com/)
- [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
- [Choose an Open Source License](https://choosealicense.com)
- [Slick Carousel](https://kenwheeler.github.io/slick)
- [Font Awesome](https://fontawesome.com)
- [Unsplash](https://unsplash.com/)

BIN
docs/content/themes/DeepThought/screenshot.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 165 KiB

After

Width:  |  Height:  |  Size: 181 KiB

6
docs/content/themes/Ergo/index.md
View File

@ -3,11 +3,11 @@
title = "Ergo"
description = "A simple blog Theme focused on writing, inspired by svbtle"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/insipx/Ergo.git"
homepage = "https://github.com/insipx/Ergo"
minimum_version = "0.4.1"

6
docs/content/themes/Zulma/index.md
View File

@ -3,11 +3,11 @@
title = "Zulma"
description = "A zola theme based off bulma.css"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/Worble/Zulma.git"
homepage = "https://github.com/Worble/Zulma"
minimum_version = "0.6.0"

214
docs/content/themes/abridge/index.md
View File

@ -1,33 +1,44 @@
+++
title = "abridge"
description = "A fast and lightweight Zola theme using semantic html, abridge.css class-light CSS, and No JS."
description = "A fast and lightweight Zola theme using semantic html, a class-light abridge.css, and No JS."
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/Jieiku/abridge.git"
homepage = "https://github.com/jieiku/abridge"
homepage = "https://github.com/jieiku/abridge/"
minimum_version = "0.14.1"
license = "MIT"
demo = "https://jieiku.github.io/abridge-demo/"
demo = "https://abridge.netlify.app/"
[extra.author]
name = "Jake G (jieiku)"
homepage = "https://github.com/jieiku"
homepage = "https://github.com/jieiku/"
+++
<div align="center">
<img src="abridge.svg"/>
# Abridge Zola Theme
Abridge is a fast and lightweight Zola theme using semantic html, class-light [abridge.css](https://github.com/jieiku/abridge.css), and No JS.
Abridge is a fast and lightweight Zola theme using semantic html, only ~6kb css before svg icons, no mandatory JS[*](https://github.com/Jieiku/abridge#contributing-and-philosophy), and perfect [Lighthouse](https://web.dev/measure/?url=https%3A%2F%2Fabridge.netlify.app) and [Observatory](https://observatory.mozilla.org/analyze/abridge.netlify.app) scores.
![abridge](screenshot.png)
There is also an [Abridge-minimal](https://github.com/jieiku/abridge.css) Theme which is used to showcase the [abridge.css framework](https://github.com/Jieiku/abridge.css/tree/master/dist)
Maintainence of this project is made possible by all the <a href="https://github.com/Jieiku/abridge/graphs/contributors">contributors</a> and <a href="https://github.com/sponsors/Jieiku">sponsors</a>. If you'd like to sponsor this project and have your avatar or company logo appear below <a href="https://github.com/sponsors/Jieiku">click here</a>. 💖
<!-- sponsors --><a href="https://github.com/yugfletcher"><img src="https://github.com/yugfletcher.png" width="60px" alt="" /></a><!-- sponsors -->
</div>
---
## Demo
[https://jieiku.github.io/abridge-demo/](https://jieiku.github.io/abridge-demo/)
[https://abridge.netlify.app/](https://abridge.netlify.app/)
## Requirements
@ -36,14 +47,14 @@ This theme requires version 0.14.1 or later of [Zola](https://www.getzola.org/do
## Quick Start
```bash
git clone https://github.com/jieiku/abridge
git clone https://github.com/jieiku/abridge.git
cd abridge
zola serve
# open http://127.0.0.1:1111/ in the browser
```
## Installation
The Quick Start example shows you how to run the theme directly as a site.
The Quick Start shows how to run the theme directly as a site.
Next we will use abridge as a theme to a NEW site.
### Step 1: Create a new zola site
@ -77,12 +88,24 @@ Enable the theme in your `config.toml` in the site directory:
theme = "abridge"
```
Or copy the `config.toml` from the theme directory to your project's
root directory, and uncomment the theme line:
Or copy the `config.toml` from the theme directory to your project's root directory:
(This will give you a base configuration with all config values used)
```bash
cp themes/abridge/config.toml config.toml
```
Uncomment the theme line, and point extra_syntaxes_and_themes at the correct directory:
```bash
sed -i 's/^#theme = "abridge"/theme = "abridge"/' config.toml
sed -i 's/^extra_syntaxes_and_themes = \["highlight_themes"\]/extra_syntaxes_and_themes = \["highlight_themes", "themes\/abridge\/highlight_themes"\]/' config.toml
```
The result should be:
```toml
theme = "abridge"
[markdown]
extra_syntaxes_and_themes = ["highlight_themes", "themes/abridge/highlight_themes"]
```
### Step 4: Add new content
@ -129,9 +152,16 @@ $mb:1200px !default;// value at which to switch from fluid layout to using max-w
Colors and style are handled by the sass files of [abridge.css](https://github.com/jieiku/abridge.css)
To change colors of this theme all you need to do is edit `/themes/abridge/sass/themes/_auto.scss`
then in the root of your site type `zola build` which will regenerate your site, this is similar to what zola serve does, except it does not facilitate serving the site.
This is also the way you should generate your site to serve it by a real webserver such as nginx.
Abridge comes with two "Skins" each with their own auto, dark, and light modes.
Auto mode automatically displays a dark or light version depending on browser/OS settings.
The skin used on [the Demo](https://abridge.netlify.app/) uses primarily orange colors.
It is defined here: `/themes/abridge/sass/abridge.scss`
There is also other variations, that you will see defined in this same directory.
To change colors or fonts all you need to do is edit these files or duplicate them and create your own skin.
Then in the root of your site type `zola build` which will regenerate your site, this is similar to what zola serve does, except it does not facilitate serving the site.
### Global Configuration
@ -161,19 +191,49 @@ The default elasticlunr search is currently used, I may eventually switch this o
#### Configuration options under the `extra`
Most Options in the config.toml are self documenting, meaning between the name of the config value and the notes in the file it is usually obvious what an option is for.
The following options should be under the `[extra]` in `config.toml`
- `language_code` - Set the site language_code.
- `title_separator` - Separator between title and title_addition, eg "|": "Abridge | Fast & Lightweight Zola Theme"
- `title_addition` - a default value for title addition, used at the index.
- `author` - Used for articles to denote the author.
- `author_show = true` - Displays the author name on line with date, tags, categories
- `readtime = true` - Displays the read time on line with date, tags, categories.
- `readtime_string` - The word following the read time, you can set this to "min", "minutes", "min read", etc.
- `recent = true` - This enabled the Recent posts box visible on the top right.
- `recent_items = 9` - The number of items to display in the recent posts box
- `footer_credit = true` - This enables the powered by zola and abridge line in the footer.
- `textlogo` - The Text based logo in the top left corner
- `footer_credit_override` - Can be used to customize the footer credit, useful to add icons to the text, etc.
- `logo = { file="logo.svg", width="42", height="42", alt="Abridge", text="bridge" }` - Defines the graphical logo with optional text to follow the logo.
- `textlogo` - A purely Text based logo, this will be used if logo is commented out, if both are commented out then config.title is used.
- `sitedesc` - This add the site description just below the text based logo.
- `author` - Used for articles to denote the author.
- `keywords` - This is used for SEO, I am however still working on the SEO related fields, they are likely not 100% correct yet.
- `banner` - Image to use in seo related cards, this will be the fallback image if the individual articles does not provide one, still a work in progress.
- `copyright_start_year` - Optionally define a start year for the copyright, otherwise the current year is used.
- `copyright_end_year` - Optionally set the copyright end year, recommend leaving unset, zola build will set this to current year by default
- `headhr` - Display a horizontal rule below header
- `foothr` - Display a horizontal rule above footer
- `menu` - This is an array of links to display at the top right corner of the page
- `menu_footer` - This is an array of links to display in the footer of the page
- `extra.social` - These are the options for the social icons in the footer, and a couple are also used in SEO related meta tags, still a work in progress.
- `security_header_referrer` - This is mostly used for tracking, the default is set to "strict-origin-when-cross-origin" [info](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy)
- `security_header_csp` - Content Security policy, to enfore security rules: [observatory](https://observatory.mozilla.org) [csp-google](https://csp-evaluator.withgoogle.com/)
- `banner` - Image to use in seo related cards, this will be the fallback image if the individual articles does not provide one, still a work in progress.
- `js_search_index = "search_index.en.js"` - The search index file to include in the header, comment out to disable.
- `js_search = "search.min.js"` - The search script file to include in the header, comment out to disable.
- `rss_atom_feed = "atom.xml"` - The atom.xml rss file to include in the header.
- `stylesheet = "abridge.css"` - The stylesheet file to include in the header.
- `fontawesome =` - Uncomment to enable fontawesome library, this will include the file in the header.
- `fonts =` - Uncomment to load external fonts, they will be loaded in the header.
- `math` - Set to true to load the Katex library, enabling the use of the [katex shortcode](https://abridge.netlify.app/overview-math/)
- `math_auto_render` - This allows you to define a section of math notation using only $$ $$ symbols instead of using the katex shortcode directly.
- `keywords =` - This is used for SEO.
- `seo =` - This is used for SEO, for the social media related tags, eg: opengraph, facebook, twitter if set to false it disables them all.
- `extra.social` - These are the options for the social icons in the footer, and a couple are also used in SEO related meta tags.
Additionally you should configure which social icons you plan to use. (makes the css file size smaller)
@ -220,28 +280,118 @@ menu_footer = [
### SEO and Header Tags
Some SEO Tags have been added as well as some important head tags for browser compatibility.
Most SEO Tags have been added as well as some important head tags for browser compatibility.
you can review them in the head section of templates/base.html, all configurable values should be in config.toml under config.extra
You can review the SEO tags in the head macro located at `templates/macros/head.html`, all configurable values should be in config.toml under config.extra or in the content markdown files.
SEO is still a work in progress, will be performing more testing and updates as time allows.
In your post markdown file you should set a title less than 60 characters and a description between 80 and 160 characters in length. The description is what is displayed in search results below the page title. Anywhere that you do not set a page description, the primary site config.description will be used instead.
You should also set page specific keywords unless your keywords defined in config.toml suffice, any keywords that you add to the page are in addition to the ones defined in config.toml, so do not add those same keywords to your page keywords.
You can optionally also set a page specific image for search results by using page.extra.thumbnail. OpenGraph recommends 1200 x 630 (1.9:1). Twitter recommends 2:1 for large and 1:1 for small. If you do not set a page specific thumbnail then the banner defined in config.toml will be used instead.
Refer to [overview-images](https://raw.githubusercontent.com/Jieiku/abridge/master/content/overview-images/index.md) for an example:
```md
+++
title = "Image Shortcodes"
description = "Images can be embeded directly using markdown `![Ferris](ferris.svg)`, but using a shortcode prevents CLS by explicitly setting the width and height."
date = 2021-05-19
[taxonomies]
categories = ["Features"]
tags = ["shortcodes","images"]
[extra]
toc = true
keywords = "Image, Markdown, Shortcodes, Hover"
thumbnail = "ferris-gesture.png"
+++
```
There are tools you can use to test your page SEO metadata, such as: [smallseotools.com](https://smallseotools.com/meta-tags-analyzer/)
### KaTeX and CSP
KaTeX unfortunately requires `script-src 'unsafe-inline'` in the Content Security Policy. This is a security vulnerability, so the demo site will not render KaTeX correctly because the demo site uses best security practices.
KaTeX js is designed to work even with dynamic content, but because Zola is a SSG it seems to me the best solution is to avoid using this javascript all-together, process our markdown files similar to how KaTeX autorender does, but do it during zola build. insert some `<span class="KaTeX_Main">` ...etc so that we basically render it during the build process. If complex mathematics were part of my daily life then I might be motivated to write such code for Zola.
You will also see [this page](https://abridge.netlify.app/overview-math/) rendered correctly if you git clone this repo and use zola serve because then there will be no Content Security Policy in place.
### Templates
All pages are extend to the `base.html`, and you can customize them as need.
All pages extend to `base.html`, and you can customize them as need.
## Optional Optimizations:
### Optimize PNG files:
All png files can be optimized using [oxipng](https://github.com/shssoichiro/oxipng), this usually results in files 1/2 the size:
```bash
cd static
oxipng -o max --strip all -a -Z *.png
```
### Consolidate two search js files into one:
Optionally you can serve a single js file for the search instead of a separate index by combining the two:
(although I am not sure how to accomplish this if your using the theme as a submodule, maybe you can use a git action for this command depending on your hosting provider.)
First comment out this line in config.toml:
```toml
#js_search_index ="search_index.en.js
```
Then build and uglifyjs:
```bash
zola build
uglifyjs search_index.en.js search.min.js -o search.min.js -c -m
```
### Pre gzip content to serve with nginx:
If you are serving your site with nginx, you can pre gzip your content.
First configure nginx:
```bash
sudo nano /etc/nginx/nginx.conf
gzip on;
gzip_vary on;
gzip_proxied expired no-cache no-store private auth;
#gzip_proxied any;
gzip_comp_level 9;
gzip_buffers 64 16k;
#gzip_buffers 16 8k;
gzip_http_version 1.1;
gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript image/svg+xml application/xhtml+xml application/x-javascript application/x-font-ttf application/vnd.ms-fontobject font/opentype font/ttf font/eot font/otf;
#gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript;
```
Then you can gzip your files:
```bash
zola build
find ./public -type f -regextype posix-extended -regex '.*\.(htm|html|css|js|xml|xsl|txt|woff|woff2|svg|otf|eot|ttf)' -exec gzip -k -9 -f {} \;
```
## Reporting Issues
We use GitHub Issues as the official bug tracker for **abridge**. Please
search [existing issues](https://github.com/jieiku/abridge/issues). It’s
possible someone has already reported the same problem.
We use GitHub Issues as the official bug tracker for **abridge**.
Please search [existing issues](https://github.com/jieiku/abridge/issues).
It’s possible someone has already reported the same problem.
If your problem or idea is not addressed yet, [open a new issue](https://github.com/jieiku/abridge/issues/new).
## Contributing
## Contributing and Philosophy
We'd love your help! Especially with fixes to issues.
The overall idea behind abridge is to be lightweight and fast, and to use zero javascript other than the search.
The overall idea behind abridge is to be lightweight and fast, and to work properly even if javascript is disabled.
The only feature that some people may consider a necessity that relies on javascript is the Search.
Any feature added to abridge that relies on javascript will do so with it disabled by default.
## License

BIN
docs/content/themes/abridge/screenshot.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 202 KiB

After

Width:  |  Height:  |  Size: 119 KiB

10
docs/content/themes/adidoks/index.md
View File

@ -3,14 +3,14 @@
title = "adidoks"
description = "AdiDoks is a Zola theme helping you build modern documentation."
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/aaranxu/adidoks.git"
homepage = "https://github.com/aaranxu/adidoks"
minimum_version = "0.13.0"
minimum_version = "0.15.0"
license = "MIT"
demo = "https://adidoks.netlify.app/"
@ -30,7 +30,7 @@ theme [Doks](https://github.com/h-enk/doks) for Zola.
## Requirements
Before using the theme, you need to install the [Zola](https://www.getzola.org/documentation/getting-started/installation/) ≥ 0.13.0.
Before using the theme, you need to install the [Zola](https://www.getzola.org/documentation/getting-started/installation/) ≥ 0.15.0.
## Quick Start

6
docs/content/themes/after-dark/index.md
View File

@ -3,11 +3,11 @@
title = "after-dark"
description = "A robust, elegant dark theme"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/getzola/after-dark.git"
homepage = "https://github.com/getzola/after-dark"
minimum_version = "0.11.0"

6
docs/content/themes/anatole-zola/index.md
View File

@ -3,11 +3,11 @@
title = "anatole-zola"
description = "A port of farbox-theme-Anatole for zola"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/longfangsong/anatole-zola.git"
homepage = "https://github.com/longfangsong/anatole-zola"
minimum_version = "0.4.0"

6
docs/content/themes/anpu/index.md
View File

@ -3,11 +3,11 @@
title = "Anpu"
description = "A port of the Hugo Anubis theme"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/zbrox/anpu-zola-theme.git"
homepage = "https://github.com/zbrox/anpu-zola-theme"
minimum_version = "0.11.0"

83
docs/content/themes/apollo/index.md Normal file
View File

@ -0,0 +1,83 @@
+++
title = "apollo"
description = "Modern and minimalistic blog theme"
template = "theme.html"
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/not-matthias/apollo.git"
homepage = "https://github.com/not-matthias/apollo"
minimum_version = "0.14.0"
license = "MIT"
demo = "https://not-matthias.github.io/apollo"
[extra.author]
name = "not-matthias"
homepage = "https://github.com/not-matthias"
+++
# apollo
Modern and minimalistic blog theme powered by [Zola](getzola.org). See a live preview [here](https://not-matthias.github.io/apollo).
<sub><sup>Named after the greek god of knowledge, wisdom and intellect</sup></sub>
<details open>
<summary>Dark theme</summary>
![blog-dark](https://user-images.githubusercontent.com/26800596/168986771-4ed049e2-e123-4d0e-8a24-7bf43f47551f.png)
</details>
<details>
<summary>Light theme</summary>
![blog-light](https://user-images.githubusercontent.com/26800596/168986766-72a48517-7122-465d-8108-3ae33e1e88b1.png)
</details>
## Features
- [X] Pagination
- [X] Themes (light, dark, auto)
- [X] Analytics using [GoatCounter](https://www.goatcounter.com/)
- [ ] Social Links
- [ ] Search
- [ ] Categories
## Installation
1. Download the theme
```
git submodule add https://github.com/not-matthias/apollo themes/apollo
```
2. Add `theme = "apollo"` to your `config.toml`
3. Copy the example content
```
cp themes/apollo/content content
```
## Options
### Additional stylesheets
You can add stylesheets to override the theme:
```toml
[extra]
stylesheets = [
"override.css",
"something_else.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 based on [archie-zola](https://github.com/XXXMrG/archie-zola/).

BIN
docs/content/themes/apollo/screenshot.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 58 KiB

19
docs/content/themes/archie-zola/index.md
View File

@ -3,11 +3,11 @@
title = "archie-zola"
description = "A zola theme based on Hugo archie."
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/XXXMrG/archie-zola.git"
homepage = "https://github.com/XXXMrG/archie-zola"
minimum_version = "0.14.0"
@ -22,18 +22,18 @@ homepage = "https://github.com/XXXMrG"
# archie-zola
A zola theme forked from https://github.com/athul/archie
A zola theme forked from [https://github.com/athul/archie](https://github.com/athul/archie)
## Demo
The Main branch source code hosted on https://archie-zola.vercel.app/
The Main branch source code hosted on [https://archie-zola.vercel.app](https://archie-zola.vercel.app)
### ScreenShot
![screenshot-light](https://github.com/XXXMrG/archie-zola/blob/main/static/screenshot/screenshot-light.png)
![screenshot-light](https://archie-zola.vercel.app/screenshot/screenshot-light.png)
![screenshot-dark](https://github.com/XXXMrG/archie-zola/blob/main/static/screenshot/screenshot-dark.png)
![screenshot-dark](https://archie-zola.vercel.app/screenshot/screenshot-dark.png)
## Installation
@ -63,10 +63,10 @@ theme = "archie-zola"
* Tags
* Auto Dark Mode(based on system theme)
* Dark/Light Mode toggle
* Google Analytics Script
in the planning stage：
- [ ] Google Analytics Script
- [ ] Custom CSS & JS
- [ ] Twitter Cards & Youtube video
@ -95,6 +95,9 @@ favicon = "/icon/favicon.png"
# show in the footer
copyright = "keith"
# config your Google Analysis ID
ga = "XXXX-XXXXX"
# config menu path
[[extra.menu]]

8
docs/content/themes/blow/index.md
View File

@ -3,11 +3,11 @@
title = "Blow"
description = "A Zola theme made with Tailwindcss"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/tchartron/blow.git"
homepage = "https://github.com/tchartron/blow"
minimum_version = "0.9.0"
@ -94,10 +94,12 @@ items = [
[extra.index]
title = "Main title"
image = "https://via.placeholder.com/200"
image_alt = "Placeholder text describing the index's image."
[extra.default_author]
name = "John Doe"
avatar = "https://via.placeholder.com/200"
avatar_alt = "Placeholder text describing the default author's avatar."
[extra.social]
github = "https://github.com/johndoe"

6
docs/content/themes/book/index.md
View File

@ -3,11 +3,11 @@
title = "book"
description = "A book theme inspired from GitBook/mdBook"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/getzola/book.git"
homepage = "https://github.com/getzola/book"
minimum_version = "0.5.0"

6
docs/content/themes/clean-blog/index.md
View File

@ -3,11 +3,11 @@
title = "Clean Blog"
description = "A port of Start Bootstrap Clean Blog for Zola"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/dave-tucker/zola-clean-blog.git"
homepage = "https://github.com/dave-tucker/zola-clean-blog"
minimum_version = "0.4.0"

6
docs/content/themes/codinfox-zola/index.md
View File

@ -3,11 +3,11 @@
title = "codinfox-zola"
description = "Codinfox theme for Zola"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/svavs/codinfox-zola.git"
homepage = "https://github.com/svavs/codinfox-zola"
minimum_version = "0.11.0"

8
docs/content/themes/d3c3nt/index.md
View File

@ -3,13 +3,13 @@
title = "d3c3nt"
description = "A simple, clean, and flexible theme for personal sites."
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://git.figbert.com/FIGBERT/d3c3nt.git"
homepage = "https://github.com/figbert/d3c3nt"
homepage = "https://git.figbert.com/figbert/d3c3nt"
minimum_version = "0.15.0"
license = "GPLv3"
demo = "https://d3c3nt.figbert.com"

6
docs/content/themes/dinkleberg/index.md
View File

@ -3,11 +3,11 @@
title = "dinkleberg"
description = "The Rust BR theme for Gutenberg"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/rust-br/dinkleberg.git"
homepage = "https://github.com/rust-br/dinkleberg"
minimum_version = "0.4.0"

6
docs/content/themes/docsascode-theme/index.md
View File

@ -3,11 +3,11 @@
title = "Docsascode_theme"
description = "A modern simple Zola's theme related to docs as code methodology"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/codeandmedia/zola_docsascode_theme.git"
homepage = "https://github.com/codeandmedia/zola_docsascode_theme"
minimum_version = "0.10.0"

6
docs/content/themes/dose/index.md
View File

@ -3,11 +3,11 @@
title = "dose"
description = "a small blog theme"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/oltdaniel/dose.git"
homepage = "https://github.com/oltdaniel/dose"
minimum_version = "0.14.0"

6
docs/content/themes/emily/index.md
View File

@ -3,11 +3,11 @@
title = "emily_zola_theme"
description = "a KISS theme for Zola"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/kyoheiu/emily_zola_theme.git"
homepage = "https://github.com/kyoheiu/emily_zola_theme"
minimum_version = "0.14.1"

6
docs/content/themes/even/index.md
View File

@ -3,11 +3,11 @@
title = "even"
description = "A robust, elegant dark theme"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/getzola/even.git"
homepage = "https://github.com/getzola/even"
minimum_version = "0.11.0"

10
docs/content/themes/feather/index.md
View File

@ -3,20 +3,20 @@
title = "feather"
description = "A modern blog theme"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/piedoom/feather.git"
homepage = "https://github.com/piedoom/feather"
minimum_version = "0.5.1"
minimum_version = "0.11.0"
license = "MIT"
demo = ""
[extra.author]
name = "doomy"
homepage = "https://alexanderlozada.com"
homepage = "https://doomy.org"
+++
# feather

27
docs/content/themes/float/index.md
View File

@ -3,20 +3,20 @@
title = "Float"
description = "An elegant blog theme"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://gitlab.com/float-theme/float.git"
homepage = "https://float-theme.netlify.app/"
minimum_version = "0.11.0"
minimum_version = "0.15.3"
license = "MIT"
demo = ""
[extra.author]
name = "Leon"
homepage = "https://exp2.uniuni.space/"
homepage = "https://editor.leonh.space/"
+++
![Float](content/blog/2020/2020-06-14-Float theme for Zola/Float.png)
@ -46,19 +46,20 @@ Float 是一款為 [Zola](https://www.getzola.org/) 設計的佈景主題。
在您的 Zola 專案資料夾內：
把 Float 以 Git 子模組的方式加入專案內：
```shell
```sh
git submodule add https://gitlab.com/float-theme/float.git themes/float
```
編輯您的 config.toml，指定 Float 作為佈景主題：
```TOML
```toml
theme = "float"
```
編輯您的 config.toml，加入 tags 作為分類系統：
```TOML
```toml
taxonomies = [
{name = "tags", paginate_by = 10},
]
@ -66,13 +67,13 @@ taxonomies = [
複製 float/static/ 的所有子資料夾與檔案到您的 static/：
```shell
```sh
cp -r themes/float/static/* static/
```
複製 float/content/ 的所有子資料夾與檔案到您的 content/：
```shell
```sh
cp -r themes/float/content/* content/
```
@ -86,7 +87,7 @@ cp -r themes/float/content/* content/
content/
└── blog/
└── 2020/
└── 2020-06-21-Float theme for Zola/
└── 2020-06-15-Zola-Theme-Float/
├── index.md
├── pic1.png
├── pic2.png
@ -99,7 +100,7 @@ content/
Front-matter 請參照下列註解說明：
```TOML
```toml
title = "Float theme for Zola"
description = "Float features and usage guide"
draft = false
@ -115,7 +116,7 @@ link = "" # 指定卡片連結，若有指定則卡片不會連結到文章頁
可客製化設定大多可以在 config.toml 的 `[extra]` 區段做設定：
```TOML
```toml
[extra]
main_section = "blog"

6
docs/content/themes/hallo/index.md
View File

@ -3,11 +3,11 @@
title = "hallo"
description = "A single-page theme to introduce yourself."
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/flyingP0tat0/zola-hallo.git"
homepage = "https://github.com/janbaudisch/zola-hallo"
minimum_version = "0.4.0"

6
docs/content/themes/hephaestus/index.md
View File

@ -3,11 +3,11 @@
title = "hephaestus"
description = "A portfolio theme"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/BConquest/hephaestus.git"
homepage = "https://github.com/BConquest/hephaestus"
minimum_version = "0.4.0"

8
docs/content/themes/hermit/index.md
View File

@ -3,11 +3,11 @@
title = "Hermit_Zola"
description = "Minimal Zola theme"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/VersBinarii/hermit_zola.git"
homepage = "https://github.com/VersBinarii/hermit_zola"
minimum_version = "0.4.0"
@ -27,7 +27,7 @@ homepage = "https://versbinarii.gitlab.io/blog/"
Hermit is a minimal & fast Zola theme for bloggers.
![screenshot](hermit_zola.png)
![screenshot](screenshot.png)
[View demo](https://versbinarii.gitlab.io/blog/)

10
docs/content/themes/hook/index.md
View File

@ -3,11 +3,11 @@
title = "Hook"
description = "Clean and simple personal site/blog theme"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/InputUsername/zola-hook.git"
homepage = "https://github.com/InputUsername/zola-hook"
minimum_version = "0.15.2"
@ -48,10 +48,14 @@ The following templates are built-in:
Templates have the following Tera blocks:
- `title` - to override the default `<title>` (`config.title`);
- `description` - to override the `<meta name="description">`'s content (`config.description`);
- `extra_head` - to override styles and anything else in `<head>`;
- `header` - to change the header (best to put this in a `<header>`);
- `content` - to change the content (best to put this in a `<main>`).
You can set a section or page description using `description` in your front matter.
By default, the `description` in `config.toml` is used.
You can define links to include in the header on the homepage in `config.toml`:
```toml
[extra]

BIN
docs/content/themes/hook/screenshot.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 41 KiB

6
docs/content/themes/hyde/index.md
View File

@ -3,11 +3,11 @@
title = "hyde"
description = "A classic blog theme"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/getzola/hyde.git"
homepage = "https://github.com/getzola/hyde"
minimum_version = "0.11.0"

6
docs/content/themes/juice/index.md
View File

@ -3,11 +3,11 @@
title = "juice"
description = "An intuitive, elegant, and lightweight Zola theme for product sites."
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/huhu/juice.git"
homepage = "https://github.com/huhu/juice"
minimum_version = "0.11.0"

43
docs/content/themes/kangae/index.md
View File

@ -3,11 +3,11 @@
title = "kangae"
description = "a lightweight microblog theme for zola"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/ayushnix/kangae.git"
homepage = "https://github.com/ayushnix/kangae"
minimum_version = "0.15.0"
@ -128,6 +128,38 @@ emoticon itself.
This shortcode can also be used for any other ASCII emoticon that can fit in an inline paragraph.
This includes western emoticons such as `;)` and combination emoticons such as `<(^_^<)`.
### Quotes
You can add quotes in your microblog posts using
```
{%/* quote(author="Nara Shikamaru") */%}
You would think just this once, when it was life or death, I could pull through.
{%/* end */%}
```
This is the most basic form of improvement in writing quotes over simply using `>` in markdown.
If you want to mention the name of the source from where the quote has been taken, such as the name
of the book or a movie, you can use
```
{%/* quote(citation="Mass Effect 3", author="Javik") */%}
Stand in the ashes of a trillion dead souls, and ask the ghosts if honor matters. The silence is your answer.
{%/* end */%}
```
A `citeurl` can also be given as an argument to this shortcode to provide the actual URL from where
the source is borrowed.
```
{%/* quote(author="Edward Snowden", citeurl="https://old.reddit.com/r/IAmA/comments/36ru89/just_days_left_to_kill_mass_surveillance_under/crglgh2/")*/%}
Arguing that you don't care about the right to privacy because you have nothing to hide is no different than saying you don't care about free speech because you have nothing to say.
{%/* end */%}
```
A live preview of these how these shortcodes look like can be found on [this blog post][14].
## Optional Features
kangae includes some optional features that aren't enabled by default
@ -148,7 +180,7 @@ If you're in India, you can also use UPI for donations. My UPI address is `ayush
I'm not really a web developer and I don't intend to be one either. However, I am interested in
learning HTML and CSS to create lightweight textual websites. You may be interested in reading [my
log about how I learned HTML and CSS][12]. However, this page is just an unorganized dump of my
log about how I learned HTML and CSS][12]. However, that page is just an unorganized dump of my
thoughts and isn't a polished blog post. [Seirdy's blog post on creating textual websites][13] is
probably a better reference.
@ -162,6 +194,8 @@ probably a better reference.
- add shortcode for asciinema
- add shortcode for blockquote and citation
- pagination
- light and dark mode switch
- content tabs
[1]: https://kangae.ayushnix.com/
[2]: https://www.getzola.org/
@ -176,5 +210,6 @@ probably a better reference.
[11]: https://github.com/ayushnix/kangae/blob/master/static/css/style-external-links.css
[12]: https://wiki.ayushnix.com/frontend/creating-a-website/
[13]: https://seirdy.one/2020/11/23/website-best-practices.html
[14]: https://kangae.ayushnix.com/being-shikamaru-102/

112
docs/content/themes/karzok/index.md
View File

@ -1,18 +1,18 @@
+++
title = "karzok"
description = "A theme for your documentation. Fast and secure"
description = "The theme for launching fast documentation sites"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/kogeletey/karzok.git"
homepage = "https://github.com/kogeletey/karzok"
minimum_version = "0.0.14"
license = "Apache-2.0"
demo = "https://fmatch.org/karzok"
minimum_version = "0.15.0"
license = "MIT"
demo = "https://karzok.re128.org"
[extra.author]
name = "Konrad Geletey"
@ -20,8 +20,11 @@ homepage = ""
+++
<p align="center">
<a href="https://builds.sr.ht/~kogeletey/karzok"><img src="https://builds.sr.ht/~kogeletey/karzok.svg" alt="builds.sr.ht status" /></a>
<a href="https://design.penpot.app/#/view/b4a9c170-5cb6-11ec-826f-e949c75b760d?page-id=ef8611e1-7c24-11eb-89c7-03f8ac143bbf&index=0&share-id=d81024f0-5cb7-11ec-826f-e949c75b760d"><img alt="designed with penpot" src="https://badgen.net/badge/designed%20with/penpot/31EFB8" /></a>
<a href="https://github.com/kogeletey/karzok/actions"><img src="https://flat.badgen.net/github/checks/kogeletey/karzok" alt="github workflows status" /></a>
<!-- <a href="https://github.com/kogeletey/karzok/actions"><img src="https://github.com/kogeletey/karzok/actions/workflows/badge.svg" alt="github workflows action status" /></a> -->
<a href="https://github.com/kogeletey/karzok/blob/develop/LICENSE"><img src="https://flat.badgen.net/github/license/kogeletey/karzok" alt="license a repository" /></a>
<a href="https://github.com/kogeletey/karzok/releases"><img src="https://flat.badgen.net/github/release/kogeletey/karzok" alt="latest release as a repository" /></a>
<a href="https://framagit.org/kogeletey/nebra"><img alt="pipeline status re128" src="https://framagit.org/kogeletey/nebra/badges/develop/pipeline.svg" /></a>
</p>
# Karzok
@ -32,7 +35,7 @@ A theme for your documentation. Fast and secure
## Demo
[Fmatch Karzok](https://fmatch.org/karzok)
[Karzok](https://karzok.re128.org)
## Requirements
@ -42,17 +45,14 @@ Karzok uses npm,zola to dependency managment,rendering, scripts and plugins.
1. [Zola](https://www.getzola.org/documentation/getting-started/installation/)
2. [Node.js](https://nodejs.org/)
3. [rsync](https://rsync.samba.org)
for your platform.
### Optional
1. [yj](https://github.com/sclevine/yj)
> for transfer toml file in yaml
2. [docker](https://docs.docker.com/engine/install/)
> for packaging container
3. [rsync](https://rsync.samba.org/)
> A better copy and move
- [docker](https://docs.docker.com/engine/install/)
> for packaging container and production
## Get Started
@ -83,7 +83,7 @@ base_url = "https://karzok.example.net" # set-up for production
theme = "karzok"
```
See more in [Karzok Configuration](#configuration)
See more in [configuration](https://karzok.re128.org/configure/)
### 4. Added new content
@ -102,7 +102,8 @@ i. development enviroment
1. Install node dependencies needed to work
```zsh
npm run gen # don't use npm install before that
npm ci
npm run gen
```
2. Just run `zola serve` in the root path of the project
@ -118,61 +119,52 @@ ii. production enviroment
- with docker
1. Build docker image
1. Write file for container
```zsh
docker build .
```Dockerfile
FROM ghcr.io/kogeletey/karzok:latest AS build-stage
# or your path to image
ADD . /www
WORKDIR /www
RUN sh /www/build.sh
FROM nginx:stable-alpine
COPY --from=build-stage /www/public /usr/share/nginx/html
EXPOSE 80
```
or if installed docker-compose
2. Run the your container
```zsh
docker-compose build
docker build -t <your_name_image> . &&\
docker run -d -p 8080:8080 <your_name_image>
```
- using gitlab-ci and gitlab-pages
```yml
image: ghcr.io/kogeletey/karzok:latest # or change use your registry
pages:
script:
- sh /www/build.sh
- mv /www/public public
artifacts:
paths:
- public/
```
2. Run containers
```zsh
docker start -d -p 80:80 container_id
```
or if installed docker-compose
```zsh
docker-compose up -d
```
Open in favorite browser [https://localhost](http://localhost)
## Configuration
## options under the `[extra]`
1. `math` - rendering math formulas throught [katex](https://katex.org)
2. `favicon` - set path to favicon icon import(default `favicon`)
3. `localcdn`- if you want to store all assets on your domain, then enable this
setting
4. `cdnurl` - you can customize your url to store assets,default use
[jsdelivr](https://www.jsdelivr.com)
5. `show_word_count` - allowing you to show number of words
6. `show_reading_time`- allowing you to show reading time
7. `children`- for header nesting to work
8. `[[extra.menu]]` - the main navigation on the site
9. `[[extra.header]]` - the header navigantion for the site
### Templates
All pages are extend to the base.html, and you can customize them as need.
Open in favorite browser [https://localhost:8080](http://localhost:8080)
## License
This program is Free Software: You can use, study share and improve it at your
will. Specifically you can redistribute and/or modify it under the terms of the
[Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0)
[MIT](https://mit-license.org/)
# Contribute
Make sure to read the [Code of Conduct](/meta/code-of-conduct)
Make sure to read the [Code of Conduct](https://karzok.re128.org/reference/code-of-conduct/)
## Find bugs and come up with features
@ -181,7 +173,7 @@ On the [todo.sr.ht](https://todo.sr.ht/~kogeletey/karzok) or
## Improve Code
The Karzok is stored in the repository at
The karzok is stored in the repository at
[sr.ht](https://sr.ht/~kogeletey/karzok) and mirror
[github](https://github.com/kogeletey/karzok)

BIN
docs/content/themes/karzok/screenshot.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 75 KiB

After

Width:  |  Height:  |  Size: 76 KiB

6
docs/content/themes/kodama-theme/index.md
View File

@ -3,11 +3,11 @@
title = "kodama"
description = "Theme insipired by wowchemy academic."
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/adfaure/kodama-theme.git"
homepage = "https://github.com/adfaure/kodama-theme"
minimum_version = "0.15"

6
docs/content/themes/lightspeed/index.md
View File

@ -3,11 +3,11 @@
title = "lightspeed"
description = "Zola theme with a perfect Lighthouse score"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/carpetscheme/lightspeed.git"
homepage = "https://github.com/carpetscheme/lightspeed"
minimum_version = "0.10.0"

8
docs/content/themes/nasm-theme/index.md
View File

@ -3,11 +3,11 @@
title = "nasm-theme"
description = "A robust, elegant blue theme"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/lucasnasm/nasm-theme.git"
homepage = "https://github.com/lucasnasm/nasm-theme"
minimum_version = "0.1.0"
@ -22,7 +22,7 @@ homepage = "https://lucasnasm.github.io"
# nasm-theme
## Web
![nasm-theme web](https://github.com/lucasnasm/nasm-theme/blob/master/screenshot-web.png?raw=true)
![nasm-theme web](screenshot.png)
## Mobile
![nasm-theme mobile](https://github.com/lucasnasm/nasm-theme/blob/master/screenshot-mobile.png?raw=true)

6
docs/content/themes/ntun/index.md
View File

@ -3,11 +3,11 @@
title = "ntun-zola-theme"
description = "A classic resume theme"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/Netoun/ntun.git"
homepage = "https://github.com/netoun/ntun"
minimum_version = "0.1.0"

6
docs/content/themes/oceanic-zen/index.md
View File

@ -3,11 +3,11 @@
title = "Oceanic Zen"
description = "Minimalistic blog theme"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/barlog-m/oceanic-zen.git"
homepage = "https://github.com/barlog-m/oceanic-zen"
minimum_version = "0.12.0"

6
docs/content/themes/papaya/index.md
View File

@ -3,11 +3,11 @@
title = "Papaya"
description = "A clean Zola theme for blogging and projects"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/justint/papaya.git"
homepage = "https://github.com/justint/papaya"
minimum_version = "0.14.0"

6
docs/content/themes/particle/index.md
View File

@ -3,11 +3,11 @@
title = "particle"
description = "Particle theme for Zola"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/svavs/particle-zola.git"
homepage = "https://github.com/svavs/particle"
minimum_version = "0.11.0"

6
docs/content/themes/resume/index.md
View File

@ -3,11 +3,11 @@
title = "resume"
description = "A resume theme"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/AlongWY/zola-resume.git"
homepage = "https://github.com/alongwy/zola-resume"
minimum_version = "0.11.0"

6
docs/content/themes/sam/index.md
View File

@ -3,11 +3,11 @@
title = "sam"
description = "A Simple and Minimalist theme with a focus on typography and content."
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/janbaudisch/zola-sam.git"
homepage = "https://github.com/janbaudisch/zola-sam"
minimum_version = "0.4.0"

8
docs/content/themes/seje2/index.md
View File

@ -3,16 +3,16 @@
title = "Seje2"
description = "A beautiful zola theme"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/eatradish/seje2"
homepage = "https://github.com/eatradish/Seje2"
minimum_version = "0.15.0"
license = "MIT"
demo = "https://eatradish.github.io/Seje2"
demo = "https://blog.miraclemilk.me/Seje2"
[extra.author]
name = "Mag Mell"

8
docs/content/themes/serene/index.md
View File

@ -3,11 +3,11 @@
title = "serene"
description = "A blog theme for zola, simple and clean."
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/isunjn/serene.git"
homepage = "https://github.com/isunjn/serene"
minimum_version = "0.9.0"
@ -54,6 +54,8 @@ Serene is a simple and clean blog theme for Static-Site-Generator [Zola](https:/
- Out-of-date warning
- Creative-Commons statement
- Comments
- Mathematical notations using [KaTeX](https://katex.org/)
- Diagrams and visualizations using [Mermaid](https://github.com/mermaid-js/mermaid)
- Web analytics
- Projects page
- Easily customize

10
docs/content/themes/simple-dev-blog/index.md
View File

@ -3,11 +3,11 @@
title = "simple-dev-blog"
description = "A simple dev blog theme with no javascript, prerendered linked pages and SEO tags."
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/bennetthardwick/simple-dev-blog-zola-starter.git"
homepage = "https://github.com/bennetthardwick/simple-dev-blog-zola-starter"
minimum_version = "0.4.0"
@ -29,7 +29,9 @@ You can view it live [here](https://simple-dev-blog-zola-starter.netlify.app/).
## How to get started
To create a new Zola site, first download the CLI and install it on your system.
To create a new Zola site, first download the CLI and install it on your system. This theme requires Zola version 0.14 or greater.
You can find installation instructions [on the Zola website](https://www.getzola.org/documentation/getting-started/installation/).
1. After you've installed the Zola CLI, run the following command to create a new site:

6
docs/content/themes/slim/index.md
View File

@ -3,11 +3,11 @@
title = "Slim"
description = "Slim is a minimal, clean and beautiful theme for Zola."
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/jameshclrk/zola-slim.git"
homepage = "https://github.com/jameshclrk/zola-slim"
minimum_version = "0.8.0"

6
docs/content/themes/soapstone/index.md
View File

@ -3,11 +3,11 @@
title = "Soapstone"
description = "A bare bones dark theme with some color tweakability"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/MattyRad/soapstone.git"
homepage = "https://github.com/MattyRad/soapstone"
minimum_version = "0.4.0"

6
docs/content/themes/solar-theme-zola/index.md
View File

@ -3,11 +3,11 @@
title = "solar-theme-zola"
description = "A port of solar-theme-hugo for zola"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/hulufei/solar-theme-zola.git"
homepage = "https://github.com/hulufei/solar-theme-zola"
minimum_version = "0.4.0"

6
docs/content/themes/tale-zola/index.md
View File

@ -3,11 +3,11 @@
title = "tale-zola"
description = "Tala-Zola is a minimal Zola theme helping you to build a nice and seo-ready blog."
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/aaranxu/tale-zola.git"
homepage = "https://github.com/aaranxu/tale-zola"
minimum_version = "0.13.0"

6
docs/content/themes/toucan/index.md
View File

@ -3,11 +3,11 @@
title = "Toucan"
description = "Inspired from Pelican default theme"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://git.42l.fr/HugoTrentesaux/toucan.git"
homepage = "https://git.42l.fr/HugoTrentesaux/toucan"
minimum_version = "0.8.0"

6
docs/content/themes/zerm/index.md
View File

@ -3,11 +3,11 @@
title = "zerm"
description = "A minimalistic and dark theme based on Radek Kozieł's theme for Hugo"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/ejmg/zerm.git"
homepage = "https://github.com/ejmg/zerm"
minimum_version = "0.8.0"

6
docs/content/themes/zhuia/index.md
View File

@ -3,11 +3,11 @@
title = "Zhuia"
description = "An elegant but still playful theme for Zola."
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/gicrisf/zhuia.git"
homepage = "https://github.com/gicrisf/zhuia"
minimum_version = "0.15.0"

6
docs/content/themes/zola-henry/index.md
View File

@ -3,11 +3,11 @@
title = "henry"
description = "A timeless blog theme"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/sirodoht/zola-henry.git"
homepage = "https://github.com/sirodoht/zola-henry"
minimum_version = "0.4.0"

6
docs/content/themes/zola-paper/index.md
View File

@ -3,11 +3,11 @@
title = "zola-paper"
description = "A clean theme inspired from hugo-paper."
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/schoenenberg/zola-paper.git"
homepage = "https://github.com/schoenenberg/zola-paper"
minimum_version = "0.11.0"

6
docs/content/themes/zola-pickles/index.md
View File

@ -3,11 +3,11 @@
title = "pickles"
description = "A modern, simple, clean blog theme for Zola."
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/lukehsiao/zola-pickles.git"
homepage = "https://github.com/lukehsiao/zola-pickles"
minimum_version = "0.13.0"

6
docs/content/themes/zola-theme-course/index.md
View File

@ -3,11 +3,11 @@
title = "Course"
description = "A zola theme designed for online courses or tutorials"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/elegaanz/zola-theme-course.git"
homepage = "https://github.com/elegaanz/zola-theme-course"
minimum_version = "0.15.0"

6
docs/content/themes/zola-theme-hikari/index.md
View File

@ -3,11 +3,11 @@
title = "Hikari"
description = "Fluid, responsive blog theme for Zola"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/waynee95/zola-theme-hikari.git"
homepage = "https://github.com/waynee95/zola-theme-hikari"
minimum_version = "0.5.1"

384
docs/content/themes/zola-theme-terminimal/index.md Normal file
View File

@ -0,0 +1,384 @@
+++
title = "terminimal"
description = "A simple, minimal retro theme"
template = "theme.html"
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/pawroman/zola-theme-terminimal.git"
homepage = "https://github.com/pawroman/zola-theme-terminimal"
minimum_version = "0.11.0"
license = "MIT"
demo = "https://pawroman.github.io/zola-theme-terminimal/"
[extra.author]
name = "Paweł Romanowski"
homepage = "https://github.com/pawroman"
+++
# Terminimal
[![Build Status](https://github.com/pawroman/zola-theme-terminimal/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/pawroman/zola-theme-terminimal/actions/workflows/pages/pages-build-deployment)
![No JavaScript](https://img.shields.io/badge/JavaScript-none-brightgreen.svg)
![Screenshot](../master/screenshot.png?raw=true)
See the live demo (of the default configuration) here:
https://pawroman.github.io/zola-theme-terminimal/
Tested with Zola v0.15.3.
#### Fork disclaimer
This theme is a fork (not a port) of "Terminal" Hugo theme
by Radosław Kozieł (aka. panr):
https://github.com/panr/hugo-theme-terminal
Many thanks for that outstanding original theme, Radek!
## Changes compared to the original theme
- Slight changes in the layout and styling.
- Content has been centered (instead of left-aligned).
- The header stripes have been spaced out.
- Tweaks to pagination, especially on mobile (small screens).
- The post title underline is dashed instead of doubly-dotted.
- All links are underlined, as per
[Brutalist Web Design Guidelines](https://www.brutalist-web.design/).
- Tweaks to header font sizes.
- Minor footer tweaks.
- Absolutely **no JavaScript**.
- No JavaScript needed to pre-process anything.
Zola with its Sass pre-processor is the only dependency.
- There's no menu trigger.
- Things load crazy fast, as it's all static content.
- Prism.js syntax highlighting is not supported (you can use
[Zola's](https://www.getzola.org/documentation/content/syntax-highlighting/)).
- All references to social media (e.g. Twitter, OpenGraph) have been removed.
- All references to external URLs (e.g. Google CDN) have been removed.
This theme's static assets are meant to be served from where it's hosted.
- [Hack](https://github.com/source-foundry/Hack) is the default font.
- The default color theme is blue (original uses orange).
### New features
- You can pick the accent color as well as background color.
There's a new `dark` background. See [Configuration](#configuration)
below for details.
- Active "section" links will change color indicating the
active section. This is all static, done at template level.
## Features retained from the original
- 5 color themes, depending on your preference:
blue (default), green, orange, pink, red.
- The shortcodes `image` and `figure` (See [Shortcodes](#shortcodes)).
- Fully responsive.
## How to start
Option A: clone the theme directly into your Zola site folder:
```
$ git clone https://github.com/pawroman/zola-theme-terminimal.git themes/terminimal
```
Option B: include it as a git submodule (it's better if you plan to use CI builders):
```
$ git submodule add https://github.com/pawroman/zola-theme-terminimal.git themes/terminimal
```
Then in your `config.toml` set:
```toml
theme = "terminimal"
# Sass compilation is required
compile_sass = true
```
Also see the Zola documentation on using themes:
https://www.getzola.org/documentation/themes/installing-and-using-themes/
## Shortcodes
The theme adds two custom shortcodes related to image handling.
### `image`
Used to show images.
Required arguments:
- **`src`**
Optional arguments:
- **`alt`**
- **`position`** (center \[default\] | left | right)
- **`style`**
Example:
```
{{/* image(src="/img/hello.png", alt="Hello Friend",
position="left", style="border-radius: 8px;") */}}
```
### `figure`
Same as `image`, but with a few extra optional arguments:
- **`caption`**
- **`caption_position`** (center \[default\] | left | right)
- **`caption_style`**
Example:
```
{{/* figure(src="http://rustacean.net/assets/rustacean-flat-gesture.png",
style="width: 25%;",
position="right"
caption_position="left",
caption="Ferris, the (unofficial) Rust mascot",
caption_style="font-weight: bold; font-style: italic;") */}}
```
## Configuration
### Colors
Both the accent colors and background colors are
configurable.
By default, both accent and background are set
to `blue`.
To configure menu, add this in `[extra]` section
of your `config.toml`:
```toml
[extra]
# One of: blue, green, orange, pink, red.
# Defaults to blue.
accent_color = "green"
# One of: blue, dark, green, orange, pink, red.
# Enabling dark background will also modify primary font color
# to be darker.
# Defaults to accent color (or, if not accent color specified, to blue).
background_color = "dark"
```
### Logo text and link
You can set the "logo" text and what it links to,
by modifying `config.toml` like so:
```toml
[extra]
# The logo text - defaults to "Terminimal theme"
logo_text = "My blog"
# The logo link - defaults to base_url.
logo_home_link = "/take/me/away!"
```
### Author and copyright
You can set the footer's copyright author name like this:
```toml
[extra]
# Author name: when specified, modifies the default
# copyright text. Apart from author, it will
# contain current year and a link to the theme.
author = "My Name"
```
If you don't like the default copyright text,
you can set it to completely custom HTML:
```toml
[extra]
# Copyright text in HTML format. If specified,
# entirely replaces default copyright and author.
copyright_html = "My custom&nbsp;<b>copyright</b>"
```
### Menu
The menu is optional, static (all items are always shown,
no matter what the screen size) and fully user-configurable.
To configure menu, add this in `[extra]` section
of your `config.toml`:
```toml
[extra]
# menu is enabled by adding menu_items (optional)
menu_items = [
# each of these is optional, name and url are required
# $BASE_URL is going to be substituted by base_url from configuration
{name = "blog", url = "$BASE_URL"},
# tags should only be enabled if you have "tags" taxonomy
# see documentation below for more details
{name = "tags", url = "$BASE_URL/tags"},
{name = "archive", url = "$BASE_URL/archive"},
{name = "about me", url = "$BASE_URL/about"},
# set newtab to true to make the link open in new tab
{name = "github", url = "url-to-your-github", newtab = true},
]
```
### Tags
The theme optionally supports tags. To enable them, create
a "tags" taxonomy in your `config.toml`:
```toml
taxonomies = [
{name = "tags"},
]
```
Enabling tags will create a new `/tags` page, and
cause them to show up in `archive` section. Note
that you still need to create a menu link to the tags
page manually.
### Pagination
Pagination is fully supported for post list (main site)
and intra-post (you can navigate to earlier and later posts).
To make sure pagination works properly, you must first configure
it in `content/_index.md`:
```
+++
# number of pages to paginate by
paginate_by = 2
# sorting order for pagination
sort_by = "date"
+++
```
Then, tweak the theme's pagination config in `config.toml`:
```toml
[extra]
# Whether to show links to earlier and later posts
# on each post page (defaults to true).
enable_post_view_navigation = true
# The text shown at the bottom of a post,
# before earlier/later post links.
# Defaults to "Thanks for reading! Read other posts?"
post_view_navigation_prompt = "Read more"
```
### Language code
Internationalization / translation is not supported
but you can set the HTML language code for your
site:
```toml
default_language = "en"
```
### Hack font subset
By default, the theme uses a mixed subset of the Hack font.
Normal weight font uses full character set
(for Unicode icons and special symbols), but all others
(bold, italic etc) use a limited subset.
This results in much smaller transfer sizes, but the subset
might not contain all the Unicode characters you need.
You can enable full unicode support in `config.toml`:
```toml
[extra]
# Use full Hack character set, not just a subset.
# Switch this to true if you need full unicode support.
# Defaults to false.
use_full_hack_font = true
```
Also see [Hack's docs](https://github.com/source-foundry/Hack/blob/master/docs/WEBFONT_USAGE.md).
### Favicon
The theme supports adding a global favicon (applies to
all pages) to the site:
```toml
# Optional: Global favicon URL and mimetype.
# Mimetype defaults to "image/x-icon".
# The URL should point at a file located
# in your site's "static" directory.
favicon = "/favicon.png"
favicon_mimetype = "image/png"
```
All the configuration options are also described in
[`config.toml`](../master/config.toml).
## Extending
Each of the templates defines named blocks, so
it should be quite easy to customize the most common things.
For example, if you want to add extra `<meta>` tags to the
base template, `index.html`, create file like this in `templates/index.html`:
```html
{%/* extends "terminimal/templates/index.html" */%}
{%/* block extra_head */%}
<meta name="description" content="My awesome website"/>
<meta name="keywords" content="Hacking,Programming,Ranting"/>
{%/* endblock */%}
```
## How to contribute
If you spot any bugs or wish to contribute new features, please create a new
[Pull Request](https://github.com/pawroman/zola-theme-terminimal/pulls).
## License
Copyright © 2019 Paweł Romanowski (pawroman)
Original theme: Copyright © 2019 Radosław Kozieł ([@panr](https://twitter.com/panr))
The theme is released under the MIT License.
Check the [license file](../master/LICENSE.md)
for more information.
The license for Hack fonts used is included in
[LICENSE-Hack.md](../master/LICENSE-Hack.md).

BIN
docs/content/themes/zola-theme-terminimal/screenshot.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 125 KiB

8
docs/content/themes/zola.386/index.md
View File

@ -3,11 +3,11 @@
title = "zola.386"
description = "Zola port of the BOOTSTRA.386 theme."
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/lopes/zola.386.git"
homepage = "https://github.com/lopes/zola.386"
minimum_version = "0.10.1"
@ -82,7 +82,7 @@ zola386_menu = [
### Social
ZOLA.386 is also prepared to deal with Google Analytics, Disqus, and Twitter --[Open Graph Protocol](https://ogp.me/) is welcome. This theme is prepared to use the output of [Favicon Generator](https://www.favicon-generator.org/), to do so, you'll just need to download the output of that site and extract in `static/images`.
As said, Disqus is supportted, but besides setting the username in `config.toml`, you also must to put a `comments = true` extra option on the pages where Disqus will be enabled --this gives you the freedom to enable or disable comments on certain posts. You can use the extra option `image` on each page, to represent that post.
As said, Disqus is supported, but besides setting the username in `config.toml`, you also must to put a `comments = true` extra option on the pages where Disqus will be enabled --this gives you the freedom to enable or disable comments on certain posts. You can use the extra option `image` on each page, to represent that post.
### Animations
All JavaScript animations can be set at `static/js/zola386.js`. Basically you can disable all animations, use one or two scans, and change the scan speed. Personally, I prefer only one scan with a speed factor of 5.

6
docs/content/themes/zola_easydocs_theme/index.md
View File

@ -3,11 +3,11 @@
title = "EasyDocs"
description = "An easy way to create docs for your project"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/codeandmedia/zola_easydocs_theme.git"
homepage = "https://github.com/codeandmedia/zola_easydocs_theme"
minimum_version = "0.13.0"

6
docs/content/themes/zolastrap/index.md
View File

@ -3,11 +3,11 @@
title = "zolastrap"
description = "A bootstrap theme for zola"
template = "theme.html"
date = 2022-05-16T01:14:18-07:00
date = 2022-06-03T14:22:50-07:00
[extra]
created = 2022-05-16T01:14:18-07:00
updated = 2022-05-16T01:14:18-07:00
created = 2022-06-03T14:22:50-07:00
updated = 2022-06-03T14:22:50-07:00
repository = "https://github.com/marcodpt/zolastrap.git"
homepage = "https://github.com/marcodpt/zolastrap"
minimum_version = "0.14.1"