Update themes gallery (#1614)

Co-authored-by: GitHub Action <action@github.com>
This commit is contained in:
Vincent Prouillet 2021-09-12 21:44:45 +02:00 committed by GitHub
parent 8258305117
commit 9946506e1c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
38 changed files with 598 additions and 166 deletions

View file

@ -3,11 +3,11 @@
title = "DeepThought"
description = "A simple blog theme focused on writing powered by Bulma and Zola."
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/RatanShreshtha/DeepThought.git"
homepage = "https://github.com/RatanShreshtha/DeepThought"
minimum_version = "0.9.0"
@ -19,38 +19,121 @@ name = "Ratan Kulshreshtha"
homepage = "https://ratanshreshtha.dev"
+++
# DeepThought
A simple blog theme focused on writing powered by Bulma and Zola.
<p align="center">
<a href="https://github.com/RatanShreshtha/DeepThought">
<img src="static/images/avatar.png" alt="Logo" width="80" height="80">
</a>
![DeepThought](./screenshot.png)
<h3 align="center">DeepThought</h3>
## Live Demo
Live version of the website is available at [here](https://deepthought-theme.netlify.app/)
<p align="center">
A simple blog theme focused on writing powered by Bulma and Zola.
<br />
<a href="https://deepthought-theme.netlify.app/docs/"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://github.com/RatanShreshtha/DeepThought">Code Repository</a>
·
<a href="https://github.com/RatanShreshtha/DeepThought/issues">Report Bug</a>
·
<a href="https://github.com/RatanShreshtha/DeepThought/issues">Request Feature</a>
</p>
</p>
## Installation
Get [Zola](https://www.getzola.org/) and follow their guide on [installing a theme](https://www.getzola.org/documentation/themes/installing-and-using-themes/).
<details open="open">
<summary><h2 style="display: inline-block">Table of Contents</h2></summary>
<ol>
<li>
<a href="#about-the-project">About The Project</a>
<ul>
<li><a href="#built-with">Built With</a></li>
</ul>
</li>
<li>
<a href="#getting-started">Getting Started</a>
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#installation">Installation</a></li>
</ul>
</li>
<li><a href="#usage">Usage</a></li>
<li><a href="#roadmap">Roadmap</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#license">License</a></li>
<li><a href="#contact">Contact</a></li>
<li><a href="#acknowledgements">Acknowledgements</a></li>
</ol>
</details>
## About The Project
[![DeepThought](./screenshot.png)](https://deepthought-theme.netlify.app/)
> A simple blog theme focused on writing powered by Bulma and Zola.
### Features
- [x] Dark Mode
- [x] Pagination
- [x] Search
- [x] Charts
- [x] Maps
- [x] Diagrams
- [x] Galleria
- [x] Analytics
- [x] Comments
- [x] Categories
- [x] Social Links
- [x] Multilingual Navbar
- [x] Katex
### Built With
* [Zola](https://www.getzola.org/)
* [Bulma](https://bulma.io/)
## Getting Started
To get a local copy up and running follow these simple steps.
### Prerequisites
You need static site generator (SSG) [Zola](https://www.getzola.org/documentation/getting-started/installation/) installed in your machine to use this theme follow their guide on [getting started](https://www.getzola.org/documentation/getting-started/overview/).
### Installation
Follow zola's guide on [installing a theme](https://www.getzola.org/documentation/themes/installing-and-using-themes/).
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.
## How to serve?
Go into your sites directory, and type `zola serve`. You should see your new site at `localhost:1111`.
## 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
## Deployment
### 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
### Theme Options
```toml
navbar_items = [
{ url = "$BASE_URL/", name = "Home" },
{ url = "$BASE_URL/posts", name = "Posts" },
{ url = "$BASE_URL/docs", name = "Docs" },
{ url = "$BASE_URL/tags", name = "Tags" },
{ url = "$BASE_URL/categories", name = "Categories" },
{ code = "en", nav_items = [
{ url = "$BASE_URL/", name = "Home" },
{ url = "$BASE_URL/posts", name = "Posts" },
{ url = "$BASE_URL/docs", name = "Docs" },
{ url = "$BASE_URL/tags", name = "Tags" },
{ url = "$BASE_URL/categories", name = "Categories" },
]},
]
# Add links to favicon, you can use https://realfavicongenerator.net/ to generate favicon for your site
@ -76,32 +159,138 @@ keybase = "<keybase_username>"
linkedin = "<linkedin_username>"
stackoverflow = "<stackoverflow_userid>"
twitter = "<twitter_username>"
instagram = "<instagram_usernaem>"
behance = "<behance_username>"
# To add google analytics
[extra.analytics]
google = "<your_gtag>"
# To add hyvor comments
# To add disqus comments
[extra.commenting]
hyvor = "<your_hyvor_website_id>"
disqus = "<your_disqus_shortname>"
# To enable mapbox maps
[extra.mapbox]
access_token = "<your_access_token>"
```
## Features
- [x] Dark Mode
- [x] Pagination
- [x] Search
- [x] Charts
- [x] Maps
- [x] Diagrams
- [x] Galleria
- [x] Analytics
- [x] Comments
- [x] Categories
- [x] Social Links
- [x] Post Sharing
#### Multilingual Navbar
If you want to have a multilingual navbar on your blog, you must add your new code language in the [languages](https://www.getzola.org/documentation/content/multilingual/#configuration) array in the `config.toml` file.
**NOTE**: Don't add you default language to this array
```toml
languages = [
{code = "fr"},
{code = "es"},
]
```
And then create and array of nav item for each language:
**NOTE**: Include your default language in this array
```toml
navbar_items = [
{ code = "en", nav_items = [
{ url = "$BASE_URL/", name = "Home" },
{ url = "$BASE_URL/posts", name = "Posts" },
{ url = "$BASE_URL/docs", name = "Docs" },
{ url = "$BASE_URL/tags", name = "Tags" },
{ url = "$BASE_URL/categories", name = "Categories" },
]},
{ code = "fr", nav_items = [
{ url = "$BASE_URL/", name = "Connexion" },
]},
{ code = "es", nav_items = [
{ url = "$BASE_URL/", name = "Publicationes" },
{ url = "$BASE_URL/", name = "Registrar" },
]}
]
```
en:
![DeepThought](./screenshot_navbar_en.png)
fr:
![DeepThought](./screenshot_navbar_fr.png)
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
```
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,
similar to `$...$` in LaTeX
* `{%/* 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:
```toml
[extra]
katex.enabled = true
katex.auto_render = true
```
## 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**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
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/)

View file

@ -3,11 +3,11 @@
title = "Ergo"
description = "A simple blog Theme focused on writing, inspired by svbtle"
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/InsidiousMind/Ergo.git"
homepage = "https://github.com/insipx/Ergo"
minimum_version = "0.4.1"

View file

@ -3,11 +3,11 @@
title = "Zulma"
description = "A zola theme based off bulma.css"
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/Worble/Zulma"
homepage = "https://github.com/Worble/Zulma"
minimum_version = "0.6.0"

View file

@ -3,11 +3,11 @@
title = "adidoks"
description = "AdiDoks is a Zola theme helping you build modern documentation."
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/aaranxu/adidoks.git"
homepage = "https://github.com/aaranxu/adidoks"
minimum_version = "0.13.0"
@ -35,10 +35,10 @@ Before using the theme, you need to install the [Zola](https://www.getzola.org/d
## Quick Start
```bash
git clone git@github.com:aaranxu/adidoks.git
git clone https://github.com/aaranxu/adidoks.git
cd adidoks
zola serve
# open http://127.0.0.1:1111/
# open http://127.0.0.1:1111/ in the browser
```
Read more from [the document of the AdiDoks](https://adidoks.org/docs/getting-started/introduction/).
@ -60,7 +60,7 @@ Download this theme to your themes directory:
```bash
cd mysite/themes
git clone git@github.com:aaranxu/adidoks.git
git clone https://github.com/aaranxu/adidoks.git
```
Or install as a submodule:
@ -68,7 +68,7 @@ Or install as a submodule:
```bash
cd mysite
git init # if your project is a git repository already, ignore this command
git submodule add git@github.com:aaranxu/adidoks.git themes/adidoks
git submodule add https://github.com/aaranxu/adidoks.git themes/adidoks
```
### Step 3: Configuration
@ -110,7 +110,9 @@ AdiDoks will start the Zola development web server accessible by default at
## Customisation
You can customize your configurations, templates and content for yourself. Look at the `config.toml`, `theme.toml`, `content` files and templates files in this repo for an idea.
You can customize your configurations, templates and content for yourself. Look
at the `config.toml`, `theme.toml`, `content` files and templates files in this
repo for an idea.
### Global Configuration
@ -136,7 +138,7 @@ build_search_index = true
The following options should be under the `[extra]` in `config.toml`
- `alanguage_code` - set HTML file language (default to `en-US`)
- `language_code` - set HTML file language (default to `en-US`)
- `theme_color` - your site's HTML color (default to `#fff`)
- `title_separator` - the separator to your site title, like `|` and `-` (defaults to `|`)
- `title_addition` - the additon content for the title of the homepage
@ -150,27 +152,28 @@ The following options should be under the `[extra]` in `config.toml`
- `[[extra.menu.social]]` - the social links on the header of the page
- `[extra.footer]` - the footer content on the left
- `[[extra.footer.nav]]` - the footer navigations on the right
- `[extra.home]` - the main content of the homepage
- `[[extra.home.list]]` - the lists' content of the homepage
### Templates
All pages are extend to the `base.html`, and you can customize for as need.
All pages are extend to the `base.html`, and you can customize them as need.
### Content
#### Homepage
Go to the `config.toml` to set your own homepage content.
Go to the *content/_index.md* file to add your own homepage content.
- `[extra]` - the main content of the homepage
- `[[extra.ist]]` - the lists' content of the homepage
#### Sections
Each section includes a `_index.md`, and you can customize it.
Each section includes a `_index.md`, and you can customize it or add your new
section under the `content` folder.
#### Pages
There are three types of pages in the site.
There are mainly three types of pages in the site.
- `blog` - blog article
- `docs` - documentation article

View file

@ -3,11 +3,11 @@
title = "after-dark"
description = "A robust, elegant dark theme"
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/getzola/after-dark.git"
homepage = "https://github.com/getzola/after-dark"
minimum_version = "0.11.0"

View file

@ -3,16 +3,16 @@
title = "anatole-zola"
description = "A port of farbox-theme-Anatole for zola"
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/longfangsong/anatole-zola.git"
homepage = "https://github.com/longfangsong/anatole-zola"
minimum_version = "0.4.0"
license = "MIT"
demo = "https://longfangsong.github.io/blog-next"
demo = "https://longfangsong.github.io"
[extra.author]
name = "longfangsong"
@ -94,18 +94,18 @@ Feel free to create a pull request if you want to translate the promotes into ot
Tags and links sections are optional.
- If you want to enable the tags page, add
- If you want to enable the tags page, add
```toml
taxonomies = [
{name = "tags"},
]
[extra.show]
tags = true
```
To your `config.toml`
- If you want to enable the links page, add
- If you want to enable the links page, add
```toml
[extra.show]
@ -114,6 +114,13 @@ Tags and links sections are optional.
and copy `content/links` to your own `content` library. And edit the `_index.md` in it to edit its content.
- If you want to add the author's name on each page, add:
```toml
[extra]
author = "John Doe"
```
### Sidebar menu
We support a bunch of social links, they are:
@ -126,6 +133,8 @@ facebook = ""
instagram = ""
dribbble = ""
weibo = ""
linkedin = ""
flickr = ""
```
Fill in your username if you want! And the logo won't appear if you leave it empty.
@ -146,13 +155,23 @@ avatar = "mm" # avatar style https://github.com/xCss/Valine/wiki/avatar-setting-
placeholder = "Say something here"
```
And [disqus](https://disqus.com/admin/create/), note disqus does not work in Mainland China:
[disqus](https://disqus.com/admin/create/), note disqus does not work in Mainland China:
```toml
[extra.comment.disqus]
name = "longfangsong"
```
And [utterances](https://utteranc.es/):
```toml
[extra.comment.utterances]
repo = "Your repo for comments"
issue_term = "pathname"
theme = "github-light"
```
## Customize
There are several points I left in the origin templates for you to customize your site.
@ -180,4 +199,5 @@ You can add more social links by adding a `templates.html` with some content add
```
If you want to use some awsome logos, [font awsome icons](https://fontawesome.com/icons?d=gallery) are already available.

View file

@ -3,11 +3,11 @@
title = "Anpu"
description = "A port of the Hugo Anubis theme"
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/zbrox/anpu-zola-theme.git"
homepage = "https://github.com/zbrox/anpu-zola-theme"
minimum_version = "0.11.0"

View file

@ -3,11 +3,11 @@
title = "book"
description = "A book theme inspired from GitBook/mdBook"
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/getzola/book.git"
homepage = "https://github.com/getzola/book"
minimum_version = "0.5.0"

View file

@ -3,11 +3,11 @@
title = "Clean Blog"
description = "A port of Start Bootstrap Clean Blog for Zola"
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/dave-tucker/zola-clean-blog"
homepage = "https://github.com/dave-tucker/zola-clean-blog"
minimum_version = "0.4.0"

View file

@ -3,11 +3,11 @@
title = "codinfox-zola"
description = "Codinfox theme for Zola"
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/svavs/codinfox-zola"
homepage = "https://github.com/svavs/codinfox-zola"
minimum_version = "0.11.0"
@ -37,7 +37,8 @@ This theme supports:
2. Changable sidebar locations (reverse it by changing the boolean value in `_config.scss`)
3. Integration of FontAwesome, MathJax, Disqus and Google Analytics
4. Support for multilingual sites
4. and numerous improvements over original Lanyon and Codinfox-Lanyon
5. Support for Gravatar
6. and numerous improvements over original Lanyon and Codinfox-Lanyon
All the configuration variables and their meaning are inside:
@ -52,6 +53,20 @@ Learn more and contribute on [GitHub](https://github.com/svavs/codinfox-zola).
Have questions or suggestions? Feel free to [open an issue on GitHub](https://github.com/svavs/codinfox-zola/issues/new) or [ask me on Twitter](https://twitter.com/svavs).
### Before you start
[Get a gravatar account](https://gravatar.com) and set this up with a profile image.
#### Add gravatar profile image to codinfox-zola theme
1. login to gravatar.com
2. click My Profile
3. click **view profile** in RH sidebar beneath profile name
4. click JSON
5. copy the `hash` value on line 4
6. paste the `hash` value to `author.toml` line 10
### Install and use
To use this theme you can follow the instruction required by any Zola theme.
@ -65,6 +80,8 @@ To define your own home picture, put an image file in the `static/img/` folder a
Now is possible to create the content inside the `content` folder as usual for Zola sites.
If you want to have a Blog with this theme, then create a folder inside the `content` folder containing all the blog posts in Markdown format. Zola automatically generate a section that you can manage as a blog. See an example in the [live demo](https://codinfox-zola.vercel.app/blog/).
## License

View file

@ -3,11 +3,11 @@
title = "dinkleberg"
description = "The Rust BR theme for Gutenberg"
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/rust-br/dinkleberg.git"
homepage = "https://github.com/rust-br/dinkleberg"
minimum_version = "0.4.0"

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 = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/codeandmedia/zola_docsascode_theme.git"
homepage = "https://github.com/codeandmedia/zola_docsascode_theme"
minimum_version = "0.10.0"

View file

@ -3,11 +3,11 @@
title = "dose"
description = "a small blog theme"
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/oltd/dose.git"
homepage = "https://github.com/oltd/dose"
minimum_version = "0.13.0"

View file

@ -3,11 +3,11 @@
title = "even"
description = "A robust, elegant dark theme"
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/getzola/even.git"
homepage = "https://github.com/getzola/even"
minimum_version = "0.11.0"

View file

@ -3,11 +3,11 @@
title = "feather"
description = "A modern blog theme"
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/piedoom/feather"
homepage = "https://github.com/piedoom/feather"
minimum_version = "0.5.1"

View file

@ -3,11 +3,11 @@
title = "Float"
description = "An elegant blog theme"
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://gitlab.com/float-theme/float.git"
homepage = "https://float-theme.netlify.app/"
minimum_version = "0.11.0"

View file

@ -3,11 +3,11 @@
title = "hallo"
description = "A single-page theme to introduce yourself."
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/flyingP0tat0/zola-hallo.git"
homepage = "https://github.com/janbaudisch/zola-hallo"
minimum_version = "0.4.0"

View file

@ -3,11 +3,11 @@
title = "hyde"
description = "A classic blog theme"
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/getzola/hyde.git"
homepage = "https://github.com/getzola/hyde"
minimum_version = "0.11.0"

View file

@ -3,11 +3,11 @@
title = "juice"
description = "An intuitive, elegant, and lightweight Zola theme for product sites."
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/huhu/juice"
homepage = "https://github.com/huhu/juice"
minimum_version = "0.11.0"

View file

@ -0,0 +1,190 @@
+++
title = "karzok"
description = "A theme for your documentation. Fast and secure"
template = "theme.html"
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/kogeletey/karzok"
homepage = "https://fmatch.org/karzok"
minimum_version = "0.0.14"
license = "Apache-2.0"
demo = "https://fmatch.org/karzok"
[extra.author]
name = "Konrad Geletey"
homepage = ""
+++
[![builds.sr.ht status](https://builds.sr.ht/~kogeletey/karzok.svg)](https://builds.sr.ht/~kogeletey/karzok?)
# Karzok
A theme for your documentation. Fast and secure
![screenshot](./screenshot.png)
## Demo
[Fmatch Karzok](https://fmatch.org/karzok)
## Requirements
Karzok uses npm,zola to dependency managment,rendering, scripts and plugins.
### Install
1. [Zola](https://www.getzola.org/documentation/getting-started/installation/)
2. [Node.js](https://nodejs.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
## Get Started
### 1. Create a new zola site
```zsh
zola init zola_site
```
### 2. Download this theme to you themes directory:
```zsh
git clone https://git.sr.ht/~kogeletey/karzok zola_site/themes
```
or install as submodule:
```zsh
cd zola_site
git init # if your project is a git repository already, ignore this command
git submodule add https://git.sr.ht/~kogeletey/karzok zola_site/themes
```
### 3. Configuration. Open in favorite editor `config.toml`
```toml
base_url = "https://karzok.example.net" # set-up for production
theme = "karzok"
```
See more in [Karzok Configuration](#configuration)
### 4. Added new content
```zsh
cp ./themes/content/_index.md content/_index.md
cp ./thems/content/tmpl.md content/filename.md
```
how you can give freedom to your creativity
### 5. Run the project
#### With [docker-compose](https://docs.docker.com/compose) and [cargo make](https://sagiegurari.github.io/cargo-make/)
```zsh
cargo make --makefile make.toml dockerup
```
#### Without
i. development enviroment
1. Install node dependencies needed to work
```zsh
npm run gen # don't use npm install before that
```
2. Just run `zola serve` in the root path of the project
```zsh
zola serve
```
Open in favorite browser [http://127.0.0.1:1111](http://127.0.0.1:1111). Saved
changes live reolad.
ii. production enviroment
- with docker
1. Build docker image
```zsh
docker build .
```
or if installed docker-compose
```zsh
docker-compose build
```
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. `[[extra.menu]]` - the main navigation on the site
6. `[[extra.header]]` - the header navigantion for the site
### Templates
All pages are extend to the base.html, and you can customize them as need.
## 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)
# Contribute
Make sure to read the [Code of Conduct](/meta/code-of-conduct)
## Find bugs and come up with features
On the [todo.sr.ht](https://todo.sr.ht/~kogeletey/karzok) or [github issues](https://github.com/kogeletey/karzok/issues)
## Improve Code
The Karzok is stored in the repository at [sr.ht](https://sr.ht/~kogeletey/karzok) and mirror [github](https://github.com/kogeletey/karzok)
### TODOs:
- [ ] readme contrubutions
- [x] configure loading from cdn
- [x] choose code_of_conduct
- [x] proceed subpages
- [ ] create mobile version
- [x] choose license
- [ ] adding full path article in the page
- [ ] make dark theme
- [ ] continue author rendering
- [ ] adding word count
- [x] refactor home.scss
> Thank you so much for any help

Binary file not shown.

After

Width:  |  Height:  |  Size: 75 KiB

View file

@ -3,11 +3,11 @@
title = "lightspeed"
description = "Zola theme with a perfect Lighthouse score"
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/carpetscheme/lightspeed"
homepage = "https://github.com/carpetscheme/lightspeed"
minimum_version = "0.10.0"

View file

@ -3,11 +3,11 @@
title = "ntun-zola-theme"
description = "A classic resume theme"
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/Netoun/ntun"
homepage = "https://github.com/netoun/ntun"
minimum_version = "0.1.0"
@ -64,7 +64,7 @@ links = [
{ url = "", title="", icon = "fab fa-github"},
{ url = "", title="", icon = "fab fa-twitter"},
{ url = "", title="", icon = "fab fa-linkedin"},
{ url = "mailto:"title="", icon = "fas fa-envelope"}
{ url = "mailto:", title="", icon = "fas fa-envelope"}
]
# if you add languages, put your emoji flag on array
@ -75,4 +75,5 @@ languages_flags = [
If you put `$BASE_URL` in a url, it will automatically be replaced by the actual
site URL.

View file

@ -3,11 +3,11 @@
title = "Oceanic Zen"
description = "Minimalistic blog theme"
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/barlog-m/oceanic-zen.git"
homepage = "https://github.com/barlog-m/oceanic-zen"
minimum_version = "0.12.0"

View file

@ -1,18 +1,18 @@
+++
title = "Papaya"
description = "A clean blogging theme with projects"
description = "A clean Zola theme for blogging and projects"
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/justint/papaya.git"
homepage = "https://github.com/justint/papaya"
minimum_version = "0.14.0"
license = "MIT"
demo = ""
demo = "https://justintennant.me/papaya"
[extra.author]
name = "Justin Tennant"
@ -23,7 +23,7 @@ homepage = "https://justintennant.me"
A clean [Zola](https://getzola.org) theme for blogging and projects, forked from [Anpu](https://github.com/zbrox/anpu-zola-theme).
**Demo site**: https://justintennant.me/papaya/
**Demo site**: [https://justintennant.me/papaya/](https://justintennant.me/papaya/)
![index](pics/index.png)

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 = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/janbaudisch/zola-sam.git"
homepage = "https://github.com/janbaudisch/zola-sam"
minimum_version = "0.4.0"

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 = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/bennetthardwick/simple-dev-blog-zola-starter"
homepage = "https://github.com/bennetthardwick/simple-dev-blog-zola-starter"
minimum_version = "0.4.0"

View file

@ -3,11 +3,11 @@
title = "Slim"
description = "Slim is a minimal, clean and beautiful theme for Zola."
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/jameshclrk/zola-slim"
homepage = "https://github.com/jameshclrk/zola-slim"
minimum_version = "0.8.0"

View file

@ -3,11 +3,11 @@
title = "solar-theme-zola"
description = "A port of solar-theme-hugo for zola"
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/hulufei/solar-theme-zola.git"
homepage = "https://github.com/hulufei/solar-theme-zola"
minimum_version = "0.4.0"
@ -62,7 +62,7 @@ Set a field in `extra` with a key of `site_menus`:
```toml
site_menus = [
{ url = "https://github/hulufei.com/solar-theme-zola", name = "Repository" },
{ url = "https://github.com/hulufei/solar-theme-zola", name = "Repository" },
{ url = "rss.xml", name = "RSS" },
]
```

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 = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/aaranxu/tale-zola.git"
homepage = "https://github.com/aaranxu/tale-zola"
minimum_version = "0.13.0"
@ -198,6 +198,15 @@ Use Google Analytics. Add your own Google Analytics ID.
google_analytics = "UA—XXXXXXXX-X"
```
Whether to use Disqus globally and set to your disqus id name.
And you can enable the disqus on per post page with `extra.disqus` option
```toml
[extra]
disqus = false
disqus_id = ""
```
Code syntax highlighting. See also [syntax hightlighting](https://www.getzola.org/documentation/getting-started/configuration/#syntax-highlighting).
```toml
@ -252,6 +261,9 @@ on = "on" # Like: on May 3, 2021
top = "Top" # Go to the top of the page in the post
tags = "Tags" # In the page of Tags
# disqus comments block
disqus_discussion = "Discussion and feedback"
# The contents of the 404 page
p404 = "404: Page not found"
p404_info = "Oops! We can't seem to find the page you are looking for."

View file

@ -3,11 +3,11 @@
title = "Toucan"
description = "Inspired from Pelican default theme"
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://git.42l.fr/HugoTrentesaux/toucan.git"
homepage = "https://git.42l.fr/HugoTrentesaux/toucan"
minimum_version = "0.8.0"

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 = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/ejmg/zerm.git"
homepage = "https://github.com/ejmg/zerm"
minimum_version = "0.8.0"

View file

@ -3,11 +3,11 @@
title = "henry"
description = "A timeless blog theme"
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/sirodoht/zola-henry"
homepage = "https://github.com/sirodoht/zola-henry"
minimum_version = "0.4.0"

View file

@ -3,11 +3,11 @@
title = "zola-paper"
description = "A clean theme inspired from hugo-paper."
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/schoenenberg/zola-paper.git"
homepage = "https://github.com/schoenenberg/zola-paper"
minimum_version = "0.11.0"

View file

@ -3,11 +3,11 @@
title = "pickles"
description = "A modern, simple, clean blog theme for Zola."
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/lukehsiao/zola-pickles.git"
homepage = "https://github.com/lukehsiao/zola-pickles"
minimum_version = "0.13.0"
@ -20,7 +20,7 @@ homepage = "https://luke.hsiao.dev"
+++
# Pickles
Pickles is a clean, responsive blog theme based on the Hugo theme with the same name featuring pagination.
Pickles is a clean, responsive blog theme for [Zola](https://www.getzola.org/) based on the Hugo theme with the same name featuring pagination.
![pickles screenshot](https://github.com/lukehsiao/zola-pickles/blob/master/screenshot.png?raw=true)

View file

@ -3,11 +3,11 @@
title = "Hikari"
description = "Fluid, responsive blog theme for Zola"
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/waynee95/zola-theme-hikari"
homepage = "https://github.com/waynee95/zola-theme-hikari"
minimum_version = "0.5.1"

View file

@ -3,11 +3,11 @@
title = "zola.386"
description = "Zola port of the BOOTSTRA.386 theme."
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/lopes/zola.386"
homepage = "https://github.com/lopes/zola.386"
minimum_version = "0.10.1"

View file

@ -3,11 +3,11 @@
title = "EasyDocs"
description = "An easy way to create docs for your project"
template = "theme.html"
date = 2021-08-18T01:00:57-07:00
date = 2021-09-07T11:12:53+03:00
[extra]
created = 2021-08-18T01:00:57-07:00
updated = 2021-08-18T01:00:57-07:00
created = 2021-09-07T11:12:53+03:00
updated = 2021-09-07T11:12:53+03:00
repository = "https://github.com/codeandmedia/zola_easydocs_theme.git"
homepage = "https://github.com/codeandmedia/zola_easydocs_theme"
minimum_version = "0.13.0"