Compare commits
12 commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
e186f08516 | ||
|
f8020a3139 | ||
|
7135a4f367 | ||
|
dd0ce5c79a | ||
|
9946506e1c | ||
|
8258305117 | ||
|
|
9f88d7539f | ||
|
|
95163284e7 | ||
|
|
4c4fad2cfb | ||
|
|
7af662c862 | ||
|
|
276403148f | ||
|
5a418e1e39 |
18
.drone.yml
18
.drone.yml
|
|
@ -1,18 +0,0 @@
|
|||
kind: pipeline
|
||||
name: default
|
||||
|
||||
steps:
|
||||
- name: docker
|
||||
image: plugins/docker
|
||||
settings:
|
||||
repo: egraven/zola
|
||||
username: egraven
|
||||
password:
|
||||
from_secret: DOCKER_TOKEN
|
||||
tags:
|
||||
- latest
|
||||
- "${DRONE_SEMVER}"
|
||||
|
||||
trigger:
|
||||
branch:
|
||||
- release
|
||||
35
Dockerfile
35
Dockerfile
|
|
@ -1,28 +1,21 @@
|
|||
FROM lukemathwalker/cargo-chef:latest-rust-slim AS chef
|
||||
WORKDIR zola
|
||||
FROM rust:slim AS builder
|
||||
|
||||
FROM chef AS deps
|
||||
#RUN rustup target add x86_64-unknown-linux-musl
|
||||
RUN apt-get update && apt-get install -y make g++ pkg-config libssl-dev # musl-tools
|
||||
RUN apt-get update -y && \
|
||||
apt-get install -y python-pip make g++ python-setuptools libssl-dev pkg-config rsync && \
|
||||
pip install dockerize && \
|
||||
rustup target add x86_64-unknown-linux-gnu
|
||||
|
||||
FROM deps AS recipe
|
||||
WORKDIR /app
|
||||
COPY . .
|
||||
RUN cargo chef prepare --recipe-path recipe.json
|
||||
|
||||
FROM deps AS build
|
||||
COPY --from=recipe /zola/recipe.json recipe.json
|
||||
#RUN cargo chef cook --release --target x86_64-unknown-linux-musl --recipe-path recipe.json
|
||||
RUN cargo chef cook --release --recipe-path recipe.json
|
||||
RUN cargo build --release --target x86_64-unknown-linux-gnu
|
||||
|
||||
COPY . .
|
||||
#RUN cargo build --release --target x86_64-unknown-linux-musl --bin zola
|
||||
RUN cargo build --release --bin zola
|
||||
RUN mv target/x86_64-unknown-linux-gnu/release/zola /usr/bin
|
||||
RUN mkdir -p /workdir
|
||||
WORKDIR /workdir
|
||||
RUN dockerize -n -o /workdir /usr/bin/zola
|
||||
|
||||
FROM debian:bullseye-slim AS runtime
|
||||
WORKDIR zola
|
||||
#COPY --from=build zola/target/x86_64-unknown-linux-musl/release/zola /usr/local/bin/
|
||||
COPY --from=build zola/target/release/zola /usr/local/bin/
|
||||
ENTRYPOINT ["/usr/local/bin/zola"]
|
||||
|
||||
LABEL org.opencontainers.image.authors="Emelie Graven <emelie@graven.dev>"
|
||||
|
||||
FROM scratch
|
||||
COPY --from=builder /workdir .
|
||||
ENTRYPOINT [ "/usr/bin/zola" ]
|
||||
|
|
|
|||
|
|
@ -37,3 +37,5 @@
|
|||
| [guerinpe.com](https://guerinpe.com) | https://github.com/Grelot/blog |
|
||||
| [uggla.fr](https://uggla.fr) | https://github.com/uggla/blog |
|
||||
| [NorthCon e.V.](https://verein.northcon.de/) | |
|
||||
| [OrgaTalk wiki](https://wiki.orgatalk.de/) | https://github.com/orgatalk/wiki |
|
||||
| [Der Corona-Effekt](https://corona-effekt.orgatalk.de/) | https://github.com/orgatalk/corona-effekt |
|
||||
|
|
|
|||
|
|
@ -121,7 +121,7 @@ The source for all examples is this 300 pixel × 380 pixel image:
|
|||
|
||||
## Using `resize_image` in markdown via shortcodes
|
||||
|
||||
`resize_image` is a built-in Tera global function (see the [templates](@/documentation/templates/_index.md) chapter),
|
||||
`resize_image` is a Zola built-in Tera function (see the [templates](@/documentation/templates/_index.md) chapter),
|
||||
but it can be used in Markdown using [shortcodes](@/documentation/content/shortcodes.md).
|
||||
|
||||
The examples above were generated using a shortcode file named `resize_image.html` with this content:
|
||||
|
|
|
|||
|
|
@ -10,15 +10,24 @@ To get started, you will need to add the languages you want to support
|
|||
to your `config.toml`. For example:
|
||||
|
||||
```toml
|
||||
languages = [
|
||||
{code = "fr", feed = true}, # there will be a feed for French content
|
||||
{code = "fr", search = true}, # there will be a Search Index for French content
|
||||
{code = "it"}, # there won't be a feed for Italian content
|
||||
[languages.fr]
|
||||
generate_feed = true # there will be a feed for French content
|
||||
build_search_index = true
|
||||
taxonomies = [
|
||||
{name = "auteurs"},
|
||||
{name = "tags"},
|
||||
]
|
||||
```
|
||||
|
||||
If you want to use per-language taxonomies, ensure you set the `lang` field in their
|
||||
configuration.
|
||||
[languages.fr.translations]
|
||||
summary = "Mon blog"
|
||||
|
||||
[languages.it]
|
||||
# Italian language doesn't have any taxonomies/feed/search index
|
||||
|
||||
[languages.it.translations]
|
||||
summary = "Mio blog"
|
||||
|
||||
```
|
||||
|
||||
Note: By default, Chinese and Japanese search indexing is not included. You can include
|
||||
the support by building `zola` using `cargo build --features search/indexing-ja --features search/indexing-zh`.
|
||||
|
|
|
|||
|
|
@ -269,7 +269,7 @@ highlight(code);
|
|||
````
|
||||
|
||||
- `hl_lines` to highlight lines. You must specify a list of inclusive ranges of lines to highlight,
|
||||
separated by whitespaces. Ranges are 1-indexed and `linenostart` doesn't influence the values, it always refers to the codeblock line number.
|
||||
separated by ` ` (whitespace). Ranges are 1-indexed and `linenostart` doesn't influence the values, it always refers to the codeblock line number.
|
||||
|
||||
````
|
||||
```rust,hl_lines=1 3-5 9
|
||||
|
|
@ -280,7 +280,7 @@ highlight(code);
|
|||
````
|
||||
|
||||
- `hide_lines` to hide lines. You must specify a list of inclusive ranges of lines to hide,
|
||||
separated by ` `. Ranges are 1-indexed.
|
||||
separated by ` ` (whitespace). Ranges are 1-indexed.
|
||||
|
||||
````
|
||||
```rust,hide_lines=1-2
|
||||
|
|
|
|||
|
|
@ -16,12 +16,12 @@ Here is an example of using that field to render a two-level table of contents:
|
|||
<ul>
|
||||
{% for h1 in page.toc %}
|
||||
<li>
|
||||
<a href="{{h1.permalink | safe}}">{{ h1.title }}</a>
|
||||
<a href="{{ h1.permalink | safe }}">{{ h1.title }}</a>
|
||||
{% if h1.children %}
|
||||
<ul>
|
||||
{% for h2 in h1.children %}
|
||||
<li>
|
||||
<a href="{{h2.permalink | safe}}">{{ h2.title }}</a>
|
||||
<a href="{{ h2.permalink | safe }}">{{ h2.title }}</a>
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
|
|
|
|||
|
|
@ -131,7 +131,7 @@ In a similar manner to how section and pages calculate their output path:
|
|||
|
||||
The taxonomy pages are then available at the following paths:
|
||||
|
||||
```
|
||||
```txt
|
||||
$BASE_URL/$NAME/ (taxonomy)
|
||||
$BASE_URL/$NAME/$SLUG (taxonomy entry)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ We can use any continuous integration (CI) server to build and deploy our site.
|
|||
|
||||
In either case, it seems to work best if you use `git submodule` to include your theme, e.g.:
|
||||
|
||||
```shell
|
||||
```sh
|
||||
git submodule add https://github.com/getzola/after-dark.git themes/after-dark
|
||||
```
|
||||
|
||||
|
|
@ -47,7 +47,7 @@ jobs:
|
|||
- name: checkout
|
||||
uses: actions/checkout@v2
|
||||
- name: build_and_deploy
|
||||
uses: shalzz/zola-deploy-action@v0.13.0
|
||||
uses: shalzz/zola-deploy-action@v0.14.1
|
||||
env:
|
||||
# Target branch
|
||||
PAGES_BRANCH: gh-pages
|
||||
|
|
@ -110,7 +110,7 @@ Depending on how you added your theme, Travis may not know how to access
|
|||
it. The best way to ensure that it will have full access to the theme is to use git
|
||||
submodules. When doing this, ensure that you are using the `https` version of the URL.
|
||||
|
||||
```shell
|
||||
```sh
|
||||
$ git submodule add {THEME_URL} themes/{THEME_NAME}
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -21,12 +21,13 @@ This guide assumes that your Zola project is located in the root of your reposit
|
|||
Depending on how you added your theme, your repository may not contain it. The best way to ensure that the theme will
|
||||
be added is to use submodules. When doing this, ensure that you are using the `https` version of the URL.
|
||||
|
||||
```shell
|
||||
```sh
|
||||
$ git submodule add {THEME_URL} themes/{THEME_NAME}
|
||||
```
|
||||
|
||||
For example, this could look like:
|
||||
```shell
|
||||
|
||||
```sh
|
||||
$ git submodule add https://github.com/getzola/hyde.git themes/hyde
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -84,9 +84,6 @@ hard_link_static = false
|
|||
#
|
||||
taxonomies = []
|
||||
|
||||
# A list of directories used to search for additional `.sublime-syntax` files.
|
||||
extra_syntaxes = []
|
||||
|
||||
# When set to "true", a search index is built from the pages and section
|
||||
# content for `default_language`.
|
||||
build_search_index = false
|
||||
|
|
@ -96,6 +93,9 @@ build_search_index = false
|
|||
# When set to "true", all code blocks are highlighted.
|
||||
highlight_code = false
|
||||
|
||||
# A list of directories used to search for additional `.sublime-syntax` files.
|
||||
extra_syntaxes = []
|
||||
|
||||
# The theme to use for code highlighting.
|
||||
# See below for list of allowed values.
|
||||
highlight_theme = "base16-ocean-dark"
|
||||
|
|
@ -196,7 +196,7 @@ Zola currently has the following highlight themes available:
|
|||
- [ayu-dark](https://github.com/dempfi/ayu)
|
||||
- [ayu-light](https://github.com/dempfi/ayu)
|
||||
- [ayu-mirage](https://github.com/dempfi/ayu)
|
||||
- [base16-aterlierdune-light](https://atelierbram.github.io/syntax-highlighting/atelier-schemes/dune/)
|
||||
- [base16-atelierdune-light](https://atelierbram.github.io/syntax-highlighting/atelier-schemes/dune/)
|
||||
- [base16-ocean-dark](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Base16%20Ocean%20Dark)
|
||||
- [base16-ocean-light](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Base16%20Ocean%20Light)
|
||||
- [bbedit](https://tmtheme-editor.herokuapp.com/#!/editor/theme/BBEdit)
|
||||
|
|
|
|||
|
|
@ -19,7 +19,6 @@ content: String;
|
|||
title: String?;
|
||||
description: String?;
|
||||
date: String?;
|
||||
// `updated` will be the same as `date` if `date` is specified but `updated` is not in front-matter
|
||||
updated: String?;
|
||||
slug: String;
|
||||
path: String;
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ in the configuration file is `simple-blog`. Also make sure to place the variable
|
|||
Any file from the theme can be overridden by creating a file with the same path and name in your `templates` or `static`
|
||||
directory. Here are a few examples of that, assuming that the theme name is `simple-blog`:
|
||||
|
||||
```plain
|
||||
```txt
|
||||
templates/pages/post.html -> replace themes/simple-blog/templates/pages/post.html
|
||||
templates/macros.html -> replace themes/simple-blog/templates/macros.html
|
||||
static/js/site.js -> replace themes/simple-blog/static/js/site.js
|
||||
|
|
|
|||
|
|
@ -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>
|
||||
|
||||
|
||||
<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
|
||||
|
||||
[](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 = [
|
||||
{ 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:
|
||||
|
||||
|
||||
|
||||
fr:
|
||||
|
||||
|
||||
|
||||
es:
|
||||
|
||||
|
||||
|
||||
|
||||
### 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/)
|
||||
|
||||
|
||||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
@ -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.
|
||||
|
|
@ -181,3 +200,4 @@ 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.
|
||||
|
||||
|
||||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
@ -66,6 +81,8 @@ Now is possible to create the content inside the `content` folder as usual for Z
|
|||
|
||||
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
|
||||
|
||||
Open sourced under the [MIT license](LICENSE.md).
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
190
docs/content/themes/karzok/index.md
Normal file
190
docs/content/themes/karzok/index.md
Normal 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 = ""
|
||||
+++
|
||||
|
||||
[](https://builds.sr.ht/~kogeletey/karzok?)
|
||||
# Karzok
|
||||
A theme for your documentation. Fast and secure
|
||||
|
||||
|
||||
## 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
|
||||
|
||||
|
||||
BIN
docs/content/themes/karzok/screenshot.png
Normal file
BIN
docs/content/themes/karzok/screenshot.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 75 KiB |
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
@ -76,3 +76,4 @@ languages_flags = [
|
|||
If you put `$BASE_URL` in a url, it will automatically be replaced by the actual
|
||||
site URL.
|
||||
|
||||
|
||||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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/)
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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" },
|
||||
]
|
||||
```
|
||||
|
|
|
|||
|
|
@ -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."
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
Loading…
Reference in a new issue