Merge branch 'create-pull-request/patch-1607975269' into next
This commit is contained in:
Vincent Prouillet
commit
e984d6d018
91
docs/content/themes/DeepThought/index.md
Normal file
91
docs/content/themes/DeepThought/index.md
Normal file
|
|
@ -0,0 +1,91 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "DeepThought"
|
||||||
|
description = "A simple blog theme focused on writing powered by Bulma and Zola."
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://github.com/RatanShreshtha/DeepThought.git"
|
||||||
|
homepage = "https://github.com/RatanShreshtha/DeepThought"
|
||||||
|
minimum_version = "0.9.0"
|
||||||
|
license = "MIT"
|
||||||
|
demo = "https://zen-austin-0c80be.netlify.app/"
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "Ratan Kulshreshtha"
|
||||||
|
homepage = "https://ratanshreshtha.dev"
|
||||||
|
+++
|
||||||
|
|
||||||
|
# DeepThought
|
||||||
|
> A simple blog theme focused on writing powered by Bulma and Zola.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# [Live Demo](https://zen-austin-0c80be.netlify.app/)
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
Get [Zola](https://www.getzola.org/) and/or follow their 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`.
|
||||||
|
|
||||||
|
### Deployment to Github Pages or Netlify
|
||||||
|
[Zola](https://www.getzola.org) already has great documentation for deploying to [Netlify](https://www.getzola.org/documentation/deployment/netlify/) or [Github Pages](https://www.getzola.org/documentation/deployment/github-pages/). I won't bore you with a regurgitated explanation.
|
||||||
|
|
||||||
|
#### Theme Options
|
||||||
|
```toml
|
||||||
|
# Add links to favicon
|
||||||
|
[extra.favicon]
|
||||||
|
favicon_16x16 = "/icons/favicon-16x16.png"
|
||||||
|
favicon_32x32 = "/icons/favicon-32x32.png"
|
||||||
|
apple_touch_icon = "/icons/apple-touch-icon.png"
|
||||||
|
safari_pinned_tab = "/icons/safari-pinned-tab.svg"
|
||||||
|
webmanifest = "/icons/site.webmanifest"
|
||||||
|
|
||||||
|
# Author details
|
||||||
|
[extra.author]
|
||||||
|
name = "DeepThought"
|
||||||
|
avatar = "/images/avatar.png"
|
||||||
|
|
||||||
|
# Social link setup
|
||||||
|
[extra.social]
|
||||||
|
[extra.social]
|
||||||
|
facebook = "<facebook_username>"
|
||||||
|
github = "<github_username>"
|
||||||
|
keybase = "<keybase_username>"
|
||||||
|
linkedin = "<linkedin_username>"
|
||||||
|
stackoverflow = "<stackoverflow_userid>"
|
||||||
|
twitter = "<twitter_username>"
|
||||||
|
|
||||||
|
# To add google analytics
|
||||||
|
[extra.analytics]
|
||||||
|
google = "<your_gtag>"
|
||||||
|
|
||||||
|
# To add hyvor comments
|
||||||
|
[extra.commenting]
|
||||||
|
hyvor = "<your_website_id>"
|
||||||
|
|
||||||
|
# To enable mapbox maps
|
||||||
|
[extra.mapbox]
|
||||||
|
access_token = "<your_access_token>"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Features
|
||||||
|
- [x] Pagination
|
||||||
|
- [x] Search
|
||||||
|
- [x] Charts
|
||||||
|
- [x] Maps
|
||||||
|
- [x] Diagrams
|
||||||
|
- [x] Analytics
|
||||||
|
- [x] Comments
|
||||||
|
- [x] Categories
|
||||||
|
- [ ] Social Links
|
||||||
|
|
||||||
|
|
||||||
108
docs/content/themes/Ergo/index.md
Normal file
108
docs/content/themes/Ergo/index.md
Normal file
|
|
@ -0,0 +1,108 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "Ergo"
|
||||||
|
description = "A simple blog Theme focused on writing, inspired by svbtle"
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://github.com/InsidiousMind/Ergo.git"
|
||||||
|
homepage = "https://github.com/insipx/Ergo"
|
||||||
|
minimum_version = "0.4.1"
|
||||||
|
license = "MIT"
|
||||||
|
demo = "https://ergo.liquidthink.net"
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "Andrew Plaza"
|
||||||
|
homepage = "https://liquidthink.net"
|
||||||
|
+++
|
||||||
|
|
||||||
|
[ergo LIVE DEMO](http://ergo.liquidthink.net)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
A light, simple & beautiful Zola theme made with a focus on writing. Inspired by sbvtle and Pixyll.
|
||||||
|
|
||||||
|
Like both those web designs, Ergo is a theme that emphasizes content, but still tries to be stylish. Frankly, the design is
|
||||||
|
most like sbvtle (http://sbvtle.com) but without the clever svbtle Engine, Javascript, community or kudos button (kudos is on the list of additions, though! But then i'll have to use JS...)
|
||||||
|
If you find that you like all those things, please check out [svbtle](http://svbtle.com); this theme is meant as a lighter (free) alternative,
|
||||||
|
and ergo's design will most likely diverge more in the future as this theme evolves with me and it's users (if there are any).
|
||||||
|
This is not meant as a svbtle clone.
|
||||||
|
|
||||||
|
|
||||||
|
Here's a timelapse:
|
||||||
|
[](https://www.youtube.com/watch?v=ogEjvM-v_-s)
|
||||||
|
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
Get [Zola](https://www.getzola.org/) and/or follow their guide on [installing a theme](https://www.getzola.org/documentation/themes/installing-and-using-themes/).
|
||||||
|
Make sure to add `theme = "ergo"` to your `config.toml`
|
||||||
|
|
||||||
|
Ergo relies on having `paginate_by` variable set in `content/_index.md`.
|
||||||
|
|
||||||
|
#### Check zola version (only 0.11.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.11.0.
|
||||||
|
|
||||||
|
### how to serve
|
||||||
|
go into your sites directory, and type `zola serve`. You should see your new site at `localhost:1111`.
|
||||||
|
|
||||||
|
### Deployment to Github Pages or Netlify
|
||||||
|
[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.
|
||||||
|
|
||||||
|
### Customizing the Theme
|
||||||
|
All colors used on the site are from `sass/colors.scss`. There's only about 5-6 colors total.
|
||||||
|
Change them however you like! Feel free to go into theme and edit the colors. However, editing anything other than `sass/colors.scss` is strongly advised against. Continue at your own peril!
|
||||||
|
|
||||||
|
#### Theme Options
|
||||||
|
```toml
|
||||||
|
# Specify a profile picture to use for the logos in the theme. It can be svg, png, jpg, whatever, just make sure to copy the logo you want and put it in img/${YOUR_PROFILE}.*
|
||||||
|
# and update your config.toml accordingly
|
||||||
|
profile = 'profile.svg'
|
||||||
|
|
||||||
|
# Description. This is needed for SEO/site metadata purposes
|
||||||
|
description = "Simple blog theme focused on writing, inspired by svbtle"
|
||||||
|
|
||||||
|
# Color themes used by the theme (theme will use ${color_theme}.css file, generated by SASS or SCSS file with the same name). Defaults to ["default"]. User can choose either of them, default theme is the first in list.
|
||||||
|
color_themes = ["my-awesome-theme", "default"]
|
||||||
|
|
||||||
|
# website, should not be preceded with `http://`
|
||||||
|
website = "code.liquidthink.net"
|
||||||
|
|
||||||
|
# github
|
||||||
|
github = "Insipx" # case does not matter
|
||||||
|
# twitter
|
||||||
|
twitter = "liquid_think"
|
||||||
|
# email
|
||||||
|
email = "${MY_EMAIL}@cool_domain.com"
|
||||||
|
# instagram
|
||||||
|
instagram = "${your_insta}"
|
||||||
|
# keybase
|
||||||
|
keybase = "${your_keybase}"
|
||||||
|
# linkedin
|
||||||
|
linkedin = "${your_linkedin}"
|
||||||
|
# reddit
|
||||||
|
reddit = "${your_reddit}"
|
||||||
|
# youtube
|
||||||
|
youtube = "${your_youtube_channel_id}"
|
||||||
|
# if any social networks are missing from this list that you want added, open an issue. I will add it for you ASAP
|
||||||
|
# Whether to use country flags or language code
|
||||||
|
country_flags = true
|
||||||
|
```
|
||||||
|
|
||||||
|
## Features
|
||||||
|
- [x] Pagination
|
||||||
|
- [ ] Dynamic Color Schemes
|
||||||
|
- [ ] Edit Colors in `config.toml`
|
||||||
|
- [x] NoJS
|
||||||
|
- [ ] Analytics
|
||||||
|
- [x] Comments?
|
||||||
|
- [ ] Like button http://kudosplease.com/
|
||||||
|
- [ ] categories?
|
||||||
|
- [ ] related posts? (would meaningful related posts, or unmeaningful ones, be worth it w/o database?)
|
||||||
|
- [ ] user-requested: Open a Issue, or, if you're feeling up to it, a Pull Request
|
||||||
|
|
||||||
|
|
||||||
244
docs/content/themes/Zulma/index.md
Normal file
244
docs/content/themes/Zulma/index.md
Normal file
|
|
@ -0,0 +1,244 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "Zulma"
|
||||||
|
description = "A zola theme based off bulma.css"
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://github.com/Worble/Zulma"
|
||||||
|
homepage = "https://github.com/Worble/Zulma"
|
||||||
|
minimum_version = "0.6.0"
|
||||||
|
license = "MIT"
|
||||||
|
demo = "https://festive-morse-47d46c.netlify.com/"
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "Worble"
|
||||||
|
homepage = ""
|
||||||
|
+++
|
||||||
|
|
||||||
|
# Zulma
|
||||||
|
|
||||||
|
A Bulma theme for Zola. See a live preview [here](https://festive-morse-47d46c.netlify.com/)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Contents
|
||||||
|
|
||||||
|
- [Zulma](#zulma)
|
||||||
|
- [Contents](#contents)
|
||||||
|
- [Installation](#installation)
|
||||||
|
- [Javascript](#javascript)
|
||||||
|
- [Sources](#sources)
|
||||||
|
- [Building](#building)
|
||||||
|
- [Options](#options)
|
||||||
|
- [Pagination](#pagination)
|
||||||
|
- [Taxonomies](#taxonomies)
|
||||||
|
- [Menu Links](#menu-links)
|
||||||
|
- [Brand](#brand)
|
||||||
|
- [Search](#search)
|
||||||
|
- [Title](#title)
|
||||||
|
- [Theming](#theming)
|
||||||
|
- [Original](#original)
|
||||||
|
- [Known Bugs](#known-bugs)
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
First download this theme to your `themes` directory:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd themes
|
||||||
|
git clone https://github.com/Worble/Zulma
|
||||||
|
```
|
||||||
|
|
||||||
|
and then enable it in your `config.toml`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
theme = "Zulma"
|
||||||
|
```
|
||||||
|
|
||||||
|
That's it! No more configuration should be required, however it might look a little basic. Head to the [Options](#options) section to see what you can set for more customizability.
|
||||||
|
|
||||||
|
## Javascript
|
||||||
|
|
||||||
|
### Sources
|
||||||
|
|
||||||
|
All the source javascript files live in `javascript/src`. Following is a list of the javascript files, their purpose, and their sources. All files are prefixed with `zulma_` to avoid any name clashes.
|
||||||
|
|
||||||
|
- `zulma_search.js` - Used when a user types into the search box on the navbar (if enabled). Taken from [Zola's site](https://github.com/getzola/zola/blob/6100a43/docs/static/search.js).
|
||||||
|
- `zulma_navbar.js` - Used for the mobile navbar toggle. Taken from the [bulma template](https://github.com/dansup/bulma-templates/blob/6263eb7/js/bulma.js) at Bulmaswatch
|
||||||
|
- `zulma_switchcss.js` - Used for swapping themes (if enabled).
|
||||||
|
|
||||||
|
### Building
|
||||||
|
|
||||||
|
The JavaScript files are transpiled by babel, minified by webpack, sourcemaps are generated and then everything placed in `static/js`. The repo already contains the transpiled and minified files along with their corrosponding sourcemaps so you don't need to do anything to use these. If you would prefer to build it yourself, feel free to inspect the js files and then run the build process (please ensure that you have [node, npm](https://nodejs.org/en/) and optionally [yarn](https://yarnpkg.com/lang/en/) installed):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd javascript
|
||||||
|
yarn
|
||||||
|
yarn webpack
|
||||||
|
```
|
||||||
|
|
||||||
|
### Github warnings
|
||||||
|
|
||||||
|
You may get warnings about vulnerabilities from the JavaScript dependencies. These shouldn't be an issue since we only have dev-dependencies and none of the them reach the end-user, but if you don't want to run the buld process yourself, and to stop Github pestering you about security warnings, feel free to delete the top level `javascript` folder when committing.
|
||||||
|
|
||||||
|
## Options
|
||||||
|
|
||||||
|
### Pagination
|
||||||
|
|
||||||
|
Zulma makes no assumptions about your project. You can freely paginate your content folder or your taxonomies and it will adapt accordingly. For example, editing or creating section (`content/_index.md`) and setting pagination:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
paginate_by = 5
|
||||||
|
```
|
||||||
|
|
||||||
|
This is handled internally, no input is needed from the user.
|
||||||
|
|
||||||
|
### Taxonomies
|
||||||
|
|
||||||
|
Zulma has 3 taxonomies already set internally: `tags`, `cateogories` and `authors`. Setting of any these three in your config.toml like so:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
taxonomies = [
|
||||||
|
{name = "categories"},
|
||||||
|
{name = "tags", paginate_by = 5, rss = true},
|
||||||
|
{name = "authors", rss = true},
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
and setting any of them in a content file:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[taxonomies]
|
||||||
|
categories = ["Hello world"]
|
||||||
|
tags = ["rust", "ssg", "other", "test"]
|
||||||
|
authors = ["Joe Bloggs"]
|
||||||
|
```
|
||||||
|
|
||||||
|
will cause that metadata to appear on the post, either on the header for the name, or at the bottom for tags and categories, and enable those pages.
|
||||||
|
|
||||||
|
Making your own taxonomies is also designed to be as easy as possible. First, add it to your cargo.toml
|
||||||
|
|
||||||
|
```toml
|
||||||
|
taxonomies = [
|
||||||
|
{name = "links"},
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
and make the corrosponding folder in your templates, in this case: `templates\links`, and the necessary files: `templates\links\list.html` and `templates\links\single.html`
|
||||||
|
|
||||||
|
And then for each, just inherit the taxonomy master page for that page. Before rendering the content block, you may optionally set a variable called `title` for the hero to display on that page, otherwise it will use the default for that taxonomy.
|
||||||
|
|
||||||
|
In `single.html`:
|
||||||
|
|
||||||
|
```jinja
|
||||||
|
{%/* extends "Zulma/templates/taxonomy_single.html" */%}
|
||||||
|
```
|
||||||
|
|
||||||
|
In `list.html`:
|
||||||
|
|
||||||
|
```jinja
|
||||||
|
{%/* extends "Zulma/templates/taxonomy_list.html" */%}
|
||||||
|
|
||||||
|
{%/* block content */%}
|
||||||
|
{%/* set title = "These are all the Links"*/%}
|
||||||
|
{{/* super() */}}
|
||||||
|
{%/* endblock content */%}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Menu Links
|
||||||
|
|
||||||
|
In extra, setting `zulma_menu` with a list of items will cause them to render to the top menu bar. It has two paramers, `url` and `name`. These _must_ be set. If you put \$BASE_URL in a url, it will automatically be replaced by the actual site URL. This is the easiest way to allow users to navigate to your taxonomies:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
zulma_menu = [
|
||||||
|
{url = "$BASE_URL/categories", name = "Categories"},
|
||||||
|
{url = "$BASE_URL/tags", name = "Tags"},
|
||||||
|
{url = "$BASE_URL/authors", name = "Authors"}
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
On mobile, a dropdown burger is rendered using javascript. If the page detects javascript is disabled on the clients machine, it will gracefully degrade to always showing the menu (which isn't pretty, but keeps the site functional).
|
||||||
|
|
||||||
|
### Brand
|
||||||
|
|
||||||
|
In extra, setting `zulma_brand` will cause a brand image to display in the upper left of the top menu bar. This link will always lead back to the homepage. It has two parameters, `image`(optional) and `text`(required). `image` will set the brand to an image at the location specified, and `text` will provide the alt text for this image. If you put \$BASE_URL in a url, it will automatically be replaced by the actual site URL. If `image` is not set, the brand will simply be the text specified.
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
zulma_brand = {image = "$BASE_URL/images/bulma.png", text = "Home"}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Search
|
||||||
|
|
||||||
|
Zulma provides search built in. So long as `build_search_index` is set to `true` in `config.toml` then a search input will appear on the top navigation bar. This requires javascript to be enabled to function; if the page detects javascript is disabled on the clients machine, it will hide itself.
|
||||||
|
|
||||||
|
The search is shamefully stolen from [Zola's site](https://github.com/getzola/zola/blob/master/docs/static/search.js). Thanks, Vincent!
|
||||||
|
|
||||||
|
### Title
|
||||||
|
|
||||||
|
In extra, setting `zulma_title` will set a hero banner on the index page to appear with that title inside.
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
zulma_title = "Blog"
|
||||||
|
```
|
||||||
|
|
||||||
|
If you want to get fancy with it, you can set an image behind using sass like so:
|
||||||
|
|
||||||
|
```scss
|
||||||
|
.index .hero-body {
|
||||||
|
background-image: url(https://upload.wikimedia.org/wikipedia/commons/thumb/f/f6/Plum_trees_Kitano_Tenmangu.jpg/1200px-Plum_trees_Kitano_Tenmangu.jpg);
|
||||||
|
background-position: center;
|
||||||
|
background-size: cover;
|
||||||
|
background-repeat: no-repeat;
|
||||||
|
background-color: rgba(0, 0, 0, 0.6);
|
||||||
|
background-blend-mode: overlay;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
This will set the image behind the hero, and darken it so the main text can still be easily read.
|
||||||
|
|
||||||
|
### Theming
|
||||||
|
|
||||||
|
In extra, setting `zulma_theme` to a valid value will change the current colour scheme to that one. All themes were taken from [Bulmaswatch](https://jenil.github.io/bulmaswatch/). Valid theme values are:
|
||||||
|
|
||||||
|
- default
|
||||||
|
- darkly
|
||||||
|
- flatly
|
||||||
|
- pulse
|
||||||
|
- simplex
|
||||||
|
- lux
|
||||||
|
- slate
|
||||||
|
- solar
|
||||||
|
- superhero
|
||||||
|
|
||||||
|
All valid themes can also be found under the `extra.zulma_themes` variable in the `theme.toml`. Choosing no theme will set default as the theme. Setting an invalid theme value will cause the site to render improperly.
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
zulma_theme = "darkly"
|
||||||
|
```
|
||||||
|
|
||||||
|
Additionally, in extra, you can also set the `zulma_allow_theme_selection` boolean. Setting this to `true` will allow a menu in the footer to allow users to select their own theme. This option will store their theme choice in their localstorage and apply it on every page, assuming `zulma_allow_theme_selection` is still true. This requires javascript to be enabled to function; if the page detects javascript is disabled on the clients machine, it will hide itself.
|
||||||
|
|
||||||
|
Each theme contains the entirety of Bulma, and will weigh in at ~180kb. If you're running on a server severely limited on space, then I'd recommend you delete each theme you're not using, either from the source or from `/public`. Obviously, doing this will cause `zulma_allow_theme_selection` to work improperly, so make sure you either override `extra.zulma_themes` in `config.toml` to only show themes you have left or to not enable this option at all.
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
zulma_allow_theme_selection = true
|
||||||
|
```
|
||||||
|
|
||||||
|
## Original
|
||||||
|
|
||||||
|
This template is based on the [blog template](https://bulmatemplates.github.io/bulma-templates/templates/blog.html) over at [Free Bulma Templates](https://bulmatemplates.github.io/bulma-templates/). All themes were taken from [Bulmaswatch](https://jenil.github.io/bulmaswatch/). The code behind from originally adapted from the [after-dark](https://github.com/getzola/after-dark/blob/master/README.md) zola template.
|
||||||
|
|
||||||
|
## Known Bugs
|
||||||
|
|
||||||
|
- If user theme swapping is enabled and the user selects a theme different to the default, a slight delay will be introduced in page rendering as the css gets swapped out and in by the javascript. This is particularly pronounced when using the dark theme, since it will flash white before going back to black. This is better than the alternative flashes of unstyled content or old theme, but still annoying. I don't know any way around this, but with browser caching it should be fast enough to not cause serious issues.
|
||||||
|
|
||||||
|
|
||||||
92
docs/content/themes/after-dark/index.md
Normal file
92
docs/content/themes/after-dark/index.md
Normal file
|
|
@ -0,0 +1,92 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "after-dark"
|
||||||
|
description = "A robust, elegant dark theme"
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://github.com/getzola/after-dark.git"
|
||||||
|
homepage = "https://github.com/getzola/after-dark"
|
||||||
|
minimum_version = "0.11.0"
|
||||||
|
license = "MIT"
|
||||||
|
demo = "https://zola-after-dark.netlify.com"
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "Vincent Prouillet"
|
||||||
|
homepage = "https://www.vincentprouillet.com"
|
||||||
|
+++
|
||||||
|
|
||||||
|
# after-dark
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Contents
|
||||||
|
|
||||||
|
- [Installation](#installation)
|
||||||
|
- [Options](#options)
|
||||||
|
- [Top menu](#top-menu)
|
||||||
|
- [Title](#title)
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
First download this theme to your `themes` directory:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ cd themes
|
||||||
|
$ git clone https://github.com/getzola/after-dark.git
|
||||||
|
```
|
||||||
|
and then enable it in your `config.toml`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
theme = "after-dark"
|
||||||
|
```
|
||||||
|
|
||||||
|
This theme requires your index section (`content/_index.md`) to be paginated to work:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
paginate_by = 5
|
||||||
|
```
|
||||||
|
|
||||||
|
The posts should therefore be in directly under the `content` folder.
|
||||||
|
|
||||||
|
The theme requires tags and categories taxonomies to be enabled in your `config.toml`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
taxonomies = [
|
||||||
|
# You can enable/disable RSS
|
||||||
|
{name = "categories", rss = true},
|
||||||
|
{name = "tags", rss = true},
|
||||||
|
]
|
||||||
|
```
|
||||||
|
If you want to paginate taxonomies pages, you will need to overwrite the templates
|
||||||
|
as it only works for non-paginated taxonomies by default.
|
||||||
|
|
||||||
|
|
||||||
|
## Options
|
||||||
|
|
||||||
|
### Top-menu
|
||||||
|
Set a field in `extra` with a key of `after_dark_menu`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
after_dark_menu = [
|
||||||
|
{url = "$BASE_URL", name = "Home"},
|
||||||
|
{url = "$BASE_URL/categories", name = "Categories"},
|
||||||
|
{url = "$BASE_URL/tags", name = "Tags"},
|
||||||
|
{url = "https://google.com", name = "Google"},
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
If you put `$BASE_URL` in a url, it will automatically be replaced by the actual
|
||||||
|
site URL.
|
||||||
|
|
||||||
|
### Title
|
||||||
|
The site title is shown on the homepage. As it might be different from the `<title>`
|
||||||
|
element that the `title` field in the config represents, you can set the `after_dark_title`
|
||||||
|
instead.
|
||||||
|
|
||||||
|
## Original
|
||||||
|
This template is based on the Hugo template https://git.habd.as/comfusion/after-dark
|
||||||
|
|
||||||
|
|
||||||
79
docs/content/themes/anpu/index.md
Normal file
79
docs/content/themes/anpu/index.md
Normal file
|
|
@ -0,0 +1,79 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "Anpu"
|
||||||
|
description = "A port of the Hugo Anubis theme"
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://github.com/zbrox/anpu-zola-theme.git"
|
||||||
|
homepage = "https://github.com/zbrox/anpu-zola-theme"
|
||||||
|
minimum_version = "0.11.0"
|
||||||
|
license = "MIT"
|
||||||
|
demo = "https://anpu-zola-theme.netlify.app"
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "Rostislav Raykov"
|
||||||
|
homepage = "https://zbrox.com"
|
||||||
|
+++
|
||||||
|
|
||||||
|
# Anpu theme for Zola
|
||||||
|
|
||||||
|
This is a port of the Hugo theme [Anubis](https://github.com/Mitrichius/hugo-theme-anubis/tree/master/layouts) for [Zola](https://getzola.com).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
In order to use the theme you need to clone this repository in your `themes` folder and set your theme setting in `config.toml` to `anpu`. Like this
|
||||||
|
|
||||||
|
```toml
|
||||||
|
theme = "anpu"
|
||||||
|
```
|
||||||
|
|
||||||
|
This theme requires both the `tags` and `categories` taxonomies.
|
||||||
|
|
||||||
|
```toml
|
||||||
|
taxonomies = [
|
||||||
|
{ name = "categories" },
|
||||||
|
{ name = "tags" },
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
## How To Customize
|
||||||
|
|
||||||
|
There are two things you can customize:
|
||||||
|
|
||||||
|
- The links to be included in the menu
|
||||||
|
- The date format of the posts
|
||||||
|
|
||||||
|
### Menu links
|
||||||
|
|
||||||
|
In your `config.toml` under the `[extra]` section you need to set the `anpu_menu_links` list.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
anpu_menu_links = [
|
||||||
|
{ url = "$BASE_URL/about/", name = "About" },
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
If you include `$BASE_URL` in the url of a link it will be replaced to the base url of your site.
|
||||||
|
|
||||||
|
### Date format
|
||||||
|
|
||||||
|
In your `config.toml` under the `[extra]` section you need to set the `anpu_date_format` value.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
anpu_date_format = "%e %B %Y"
|
||||||
|
```
|
||||||
|
|
||||||
|
The formatting uses the standart `date` filter in Tera. The date format options you can use are listed in the [chrono crate documentation](https://tera.netlify.app/docs/#date).
|
||||||
|
|
||||||
77
docs/content/themes/book/index.md
Normal file
77
docs/content/themes/book/index.md
Normal file
|
|
@ -0,0 +1,77 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "book"
|
||||||
|
description = "A book theme inspired from GitBook/mdBook"
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://github.com/getzola/book.git"
|
||||||
|
homepage = "https://github.com/getzola/book"
|
||||||
|
minimum_version = "0.5.0"
|
||||||
|
license = "MIT"
|
||||||
|
demo = "https://zola-book.netlify.com"
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "Vincent Prouillet"
|
||||||
|
homepage = "https://www.vincentprouillet.com"
|
||||||
|
+++
|
||||||
|
|
||||||
|
# book
|
||||||
|
|
||||||
|
A theme based on [Gitbook](https://www.gitbook.com), to write documentation
|
||||||
|
or books.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Contents
|
||||||
|
|
||||||
|
- [Installation](#installation)
|
||||||
|
- [Options](#options)
|
||||||
|
- [Numbered chapters](#numbered-chapters)
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
First download this theme to your `themes` directory:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ cd themes
|
||||||
|
$ git clone https://github.com/getzola/book.git
|
||||||
|
```
|
||||||
|
and then enable it in your `config.toml`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
theme = "book"
|
||||||
|
# Optional, if you want search
|
||||||
|
build_search_index = true
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
Book will generate a book from the files you place in the `content` directory. Your book
|
||||||
|
can have two levels of hierarchy: chapters and subchapters.
|
||||||
|
|
||||||
|
Each chapter should be a `section` within the Gutenberg site and should have an `_index.md`
|
||||||
|
file that sets its `weight` front-matter variable to its chapter number. For example,
|
||||||
|
chapter 2 should have `weight = 2`. Additionally, each chapter should also set the
|
||||||
|
`sort_by = "weight"` in its front matter.
|
||||||
|
|
||||||
|
Each subchapter should be a `page` and should have its `weight` variable set to the subchapter
|
||||||
|
number. For example, subchapter 3.4 should have `weight = 4`.
|
||||||
|
|
||||||
|
Finally, you should create an `_index.md` file and set the `redirect_to` front-matter variable
|
||||||
|
to redirect to the first section of your content. For example, if your first section has the
|
||||||
|
slug `introduction`, then you would set `redirect_to = "introduction"`.
|
||||||
|
|
||||||
|
## Options
|
||||||
|
|
||||||
|
### Numbered chapters
|
||||||
|
By default, the `book` theme will number the chapters and pages in the left menu.
|
||||||
|
You can disable that by setting the `book_number_chapters` in `extra`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
book_number_chapters = false
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
78
docs/content/themes/clean-blog/index.md
Normal file
78
docs/content/themes/clean-blog/index.md
Normal file
|
|
@ -0,0 +1,78 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "Clean Blog"
|
||||||
|
description = "A port of Start Bootstrap Clean Blog for Zola"
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://github.com/dave-tucker/zola-clean-blog"
|
||||||
|
homepage = "https://github.com/dave-tucker/zola-clean-blog"
|
||||||
|
minimum_version = "0.4.0"
|
||||||
|
license = "MIT"
|
||||||
|
demo = "https://zola-clean-blog.netlify.com/"
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "Dave Tucker"
|
||||||
|
homepage = "https://dtucker.co.uk"
|
||||||
|
+++
|
||||||
|
|
||||||
|
zola-clean-blog
|
||||||
|
===============
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
A port of the StartBootstrap Clean Blog theme, for Zola.
|
||||||
|
|
||||||
|
## Demo
|
||||||
|
|
||||||
|
[Live Demo](https://zola-clean-blog.netlify.com)
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
To use the theme, clone this repository to your `themes` directory.
|
||||||
|
It requires that you use the categories and tags taxonomies.
|
||||||
|
This can be done with the following additions to `config.toml`:
|
||||||
|
```toml
|
||||||
|
theme = "zola-clean-blog"
|
||||||
|
|
||||||
|
taxonomies = [
|
||||||
|
{name = "categories", rss = true, paginate_by=5},
|
||||||
|
{name = "tags", rss = true, paginate_by=5},
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- Paginated Home/Categories/Tag Pages
|
||||||
|
- Customizable Menu
|
||||||
|
- Customizable Social Links
|
||||||
|
|
||||||
|
## How To Customize
|
||||||
|
|
||||||
|
- To replace header images, add a new image to `static/img/$page-bg.jpg` where `$page` is one of `about`, `home`, `post` or `contact`.
|
||||||
|
|
||||||
|
- To replace the copyright field, create your own `templates/index.html` to extend the template and add a `copyright` block:
|
||||||
|
```
|
||||||
|
{%/* extends "themes/zola-clean-blog/templates/index.html" */%}
|
||||||
|
{%/* block copyright */%}
|
||||||
|
Copyright %copy; Example, Inc. 2016-2019
|
||||||
|
{%/* endblock copyright */%}
|
||||||
|
```
|
||||||
|
|
||||||
|
- To add a new menu item, override `clean_blog_menu` in your `config.toml`. You can use `$BASE_URL` to reference your own site.
|
||||||
|
|
||||||
|
- To add a new social link, override `clean_blog_social` in your `config.toml`. You can use `$BASE_URL` to reference your own site.
|
||||||
|
|
||||||
|
- To add Google Analytics, you may add your script to the `extrascripts` block using your own `index.html`
|
||||||
|
```
|
||||||
|
{%/* extends "themes/zola-clean-blog/templates/index.html" */%}
|
||||||
|
{%/* block analytics */%}
|
||||||
|
<script>
|
||||||
|
...
|
||||||
|
</script>
|
||||||
|
{%/* endblock analytics */%}
|
||||||
|
```
|
||||||
|
|
||||||
76
docs/content/themes/codinfox-zola/index.md
Normal file
76
docs/content/themes/codinfox-zola/index.md
Normal file
|
|
@ -0,0 +1,76 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "codinfox-zola"
|
||||||
|
description = "Codinfox theme for Zola"
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://github.com/svavs/codinfox-zola"
|
||||||
|
homepage = "https://github.com/svavs/codinfox-zola"
|
||||||
|
minimum_version = "0.11.0"
|
||||||
|
license = "MIT"
|
||||||
|
demo = "https://svavs.github.io/"
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "Silvano Sallese"
|
||||||
|
homepage = "https://svavs.github.io/"
|
||||||
|
+++
|
||||||
|
|
||||||
|
# Codinfox-Zola
|
||||||
|
|
||||||
|
This is a [Zola](https://www.getzola.com) theme inspired to [Codinfox-Lanyon](https://codinfox.github.com/), a Lanyon based theme for [Jekyll](http://jekyllrb.com). See a live demo [here](https://codinfox-zola.vercel.app/).
|
||||||
|
|
||||||
|
This theme places content first by tucking away navigation in a hidden drawer.
|
||||||
|
|
||||||
|
* Built for [Zola](https://www.getzola.com)
|
||||||
|
* Developed on GitHub and hosted for free on [GitHub Pages](https://pages.github.com)
|
||||||
|
* Coded with [Spacemacs](https://www.spacemacs.org)
|
||||||
|
|
||||||
|
This theme supports:
|
||||||
|
|
||||||
|
1. Theme colors: you can choose your favorite theme color (changing in `_config.scss`)
|
||||||
|
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
|
||||||
|
|
||||||
|
All the configuration variables and their meaning are inside:
|
||||||
|
|
||||||
|
- `config.toml` (for the zola config variables and some extra variables required by this theme),
|
||||||
|
- `author.toml` (for the personal informations to be displayed about the author of the site),
|
||||||
|
- `nav.toml` (for the navigation menu structure available in the site's sidebar)
|
||||||
|
- `_config.scss` (for the definition of some css customizations)
|
||||||
|
|
||||||
|
The options are fairly straightforward and described in comments.
|
||||||
|
|
||||||
|
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).
|
||||||
|
|
||||||
|
### Install and use
|
||||||
|
|
||||||
|
To use this theme you can follow the instruction required by any Zola theme.
|
||||||
|
|
||||||
|
Simply clone this repository under the `themes` folder of your site's main folder.
|
||||||
|
|
||||||
|
Then, define the required extra variables in the config.toml (take it from the config.toml file of the theme), create and define the author.toml and nav.toml configuration files in the main folder of your site (the same level of the config.toml), and that's it!
|
||||||
|
|
||||||
|
To define your own home picture, put an image file in the `static/img/` folder and set the path in the config.extra.image variable.
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
Open sourced under the [MIT license](LICENSE.md).
|
||||||
|
|
||||||
|
|
||||||
|
## TODO
|
||||||
|
- recaptcha for hiding email address link (https://developers.google.com/recaptcha/intro)
|
||||||
|
- hidden multilingual links in topbar for main index section pages
|
||||||
|
|
||||||
|
|
||||||
80
docs/content/themes/dinkleberg/index.md
Normal file
80
docs/content/themes/dinkleberg/index.md
Normal file
|
|
@ -0,0 +1,80 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "dinkleberg"
|
||||||
|
description = "The Rust BR theme for Gutenberg"
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://github.com/rust-br/dinkleberg.git"
|
||||||
|
homepage = "https://github.com/rust-br/dinkleberg"
|
||||||
|
minimum_version = "0.4.0"
|
||||||
|
license = "MIT"
|
||||||
|
demo = "https://rust-br.github.io/blog/"
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "Guilherme Diego"
|
||||||
|
homepage = "https://github.com/guidiego"
|
||||||
|
+++
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Rust BR Blog template for Gutenberg
|
||||||
|
|
||||||
|
## Features
|
||||||
|
- A kind of i18n for base words as: "Next", "Previous", "Pages", "Categories"
|
||||||
|
- Blog Title and Logo on extra configurations
|
||||||
|
- Auto-sidebar links by configuration
|
||||||
|
- Simple design based on Medium
|
||||||
|
- SEO using structured data and another features
|
||||||
|
|
||||||
|
## Configurations
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
blog_logo="/imgs/common/logo.png" #will appear on top header
|
||||||
|
blog_title="rust::br::Blog" #will appear on top header after logo
|
||||||
|
|
||||||
|
## i18n words
|
||||||
|
label_tags = "Tags"
|
||||||
|
label_tag = "Tag"
|
||||||
|
label_categories = "Categorias"
|
||||||
|
label_category = "Categoria"
|
||||||
|
label_relative_posts = "Postagens Relacionadas"
|
||||||
|
label_next = "Próxima"
|
||||||
|
label_previous = "Anterior"
|
||||||
|
label_page = "Página"
|
||||||
|
label_of = "de"
|
||||||
|
label_minutes = "minutos"
|
||||||
|
|
||||||
|
og_image="" # Image that will appear on social media
|
||||||
|
og_alt_image="" # Alt for og_image
|
||||||
|
og_site_name="" # Site Name for Open Graphic
|
||||||
|
keywords="" # Keywords for SEO
|
||||||
|
|
||||||
|
educational_use="knowledge share" # OPTIONAL
|
||||||
|
copyright_year="2018" # OPTIONAL
|
||||||
|
|
||||||
|
fb_app_id="???" # OPTIONAL, Facebook App Id to help in metrics
|
||||||
|
twitter_username="@???" # OPTIONAL, Twitter User to help with metrics
|
||||||
|
|
||||||
|
## Sidebar automatic links
|
||||||
|
sidebar = [
|
||||||
|
{name = "Social", urls=[
|
||||||
|
{name="Telegram", url="https://t.me/rustlangbr"},
|
||||||
|
{name="Github", url="https://github.com/rust-br"},
|
||||||
|
]},
|
||||||
|
{name = "Divida Conhecimento!", urls=[
|
||||||
|
{name="Contribuir!", url="https://rust-br.github.io/blog/hello-world"}
|
||||||
|
]}
|
||||||
|
]
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
This configuration was the same configuration that we use on [RustBR Blog](https://rust-br.github.io/blog)
|
||||||
|
|
||||||
|
### Favicons and other stuff
|
||||||
|
By default Dinkleberg wait that you have all icons on root of your static, for it you can use the site [https://www.favicon-generator.org/](https://www.favicon-generator.org/) to generate that bundle and put it inside you `/static` :D
|
||||||
|
|
||||||
|
|
||||||
128
docs/content/themes/docsascode-theme/index.md
Normal file
128
docs/content/themes/docsascode-theme/index.md
Normal file
|
|
@ -0,0 +1,128 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "Docsascode_theme"
|
||||||
|
description = "A modern simple Zola's theme related to docs as code methodology"
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://github.com/codeandmedia/zola_docsascode_theme.git"
|
||||||
|
homepage = "https://github.com/codeandmedia/zola_docsascode_theme"
|
||||||
|
minimum_version = "0.10.0"
|
||||||
|
license = "MIT"
|
||||||
|
demo = "https://docsascode.codeandmedia.com"
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "Roman Soldatenkov"
|
||||||
|
homepage = "https://codeandmedia.com"
|
||||||
|
+++
|
||||||
|
|
||||||
|
**Demo: [docsascode.codeandmedia.com](http://docsascode.codeandmedia.com)**
|
||||||
|
|
||||||
|
I was inspired by [Linode's approach](https://www.linode.com/2020/01/17/docs-as-code-at-linode/) to creating and managing docs. They call it _docs as code methodology._ Thereby my aim was making simple and productive way to work with any sort of documents and articles through Markdown, Git and Docker/k8s optionally.
|
||||||
|
|
||||||
|
The repo contains a theme for [Zola](https://www.getzola.org/) (the best static site generator I've ever seen) and dockerfile for building Docker images with Nginx-alpine. You can pull to your Docker an [image with demo-content](https://hub.docker.com/r/codeandmedia/docsascode-theme)
|
||||||
|
|
||||||
|
```
|
||||||
|
codeandmedia/docsascode-theme:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
If you would use Docker on MacBook M1 processors \ Raspberry Pi4 64bit \ Amazon Graviton or another ARM64 - just fork the ARM64 branch or push
|
||||||
|
|
||||||
|
```
|
||||||
|
codeandmedia/docsascode-theme-arm64:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
## Perks
|
||||||
|
|
||||||
|
* light / dark switcher
|
||||||
|
* tags and authors taxonomies by default
|
||||||
|
* search
|
||||||
|
* useful UI both on mobiles and desktops
|
||||||
|
|
||||||
|
## 6 steps build your knowledge base/docs repo
|
||||||
|
|
||||||
|
1. Fork the repo
|
||||||
|
2. delete demo content and add your own (I explain how to structure it below)
|
||||||
|
3. change website name and domain in config.toml, also, change the title in _index.md in a root
|
||||||
|
4. connect your repo to dockerhub
|
||||||
|
5. build your docker image or setup [autobuilds](https://docs.docker.com/docker-hub/builds/)
|
||||||
|
6. host a builded docker image on your own way
|
||||||
|
|
||||||
|
But, zola is amazing static site generator, so you feel free to
|
||||||
|
|
||||||
|
1. download all repo files
|
||||||
|
2. again delete demo content and add your own
|
||||||
|
3. change name and domain in config.toml/index.md
|
||||||
|
4. setup zola (win, linux, mac)
|
||||||
|
5. execute zola build
|
||||||
|
6. host builded html-output anywhere you want
|
||||||
|
|
||||||
|
Zola supports Netlify and other similar services, or you can decide to create your own CI/CD process.
|
||||||
|
|
||||||
|
## How to structure your content
|
||||||
|
|
||||||
|
All your articles should be inside _content_ folder. Any images, videos, other static files should be inside _static._
|
||||||
|
|
||||||
|
### Folders
|
||||||
|
|
||||||
|
Every folder should contains _index.md like
|
||||||
|
|
||||||
|
```toml
|
||||||
|
+++
|
||||||
|
title = "Docsascode title"
|
||||||
|
description = "Description is optional"
|
||||||
|
sort_by = "date" # sort by weight or date
|
||||||
|
insert_anchor_links = "right" # if you want § next to headers
|
||||||
|
+++
|
||||||
|
```
|
||||||
|
Each folder is the section of the website, it means if you create folder foo it will be seen as _yoursitedomain.com/foo_
|
||||||
|
|
||||||
|
The theme supports folders in folders and articles + folders in one folder (see an example inside _content_). So you can store inside folder another folders and describe in index some specific details.
|
||||||
|
|
||||||
|
### Pages
|
||||||
|
|
||||||
|
A page should be started by
|
||||||
|
|
||||||
|
```toml
|
||||||
|
+++
|
||||||
|
title = "File and folders in folder"
|
||||||
|
date = 2020-01-18 # or weight
|
||||||
|
description = "Description"
|
||||||
|
insert_anchor_links = "right"
|
||||||
|
|
||||||
|
[taxonomies] #all taxonomies is optional
|
||||||
|
tags = ["newtag"]
|
||||||
|
authors = ["John Doe"]
|
||||||
|
+++
|
||||||
|
```
|
||||||
|
|
||||||
|
Zola allows to create drafts:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
draft = true
|
||||||
|
```
|
||||||
|
|
||||||
|
Also, by default you have two taxonomies: _tags_ and _authors_. It's optional, not necessary to use it on all pages. And you can add your own taxonomy:
|
||||||
|
|
||||||
|
1. Copy tags or authors folder and rename it to your taxonomy
|
||||||
|
2. Add your taxonomy to config.toml
|
||||||
|
3. Add to page.html template code like
|
||||||
|
|
||||||
|
```rust
|
||||||
|
{%/* if page.taxonomies.yourtaxonomynameplural */%}
|
||||||
|
<ul>
|
||||||
|
{%/* for tag in page.taxonomies.yourtaxonomynameplural */%}
|
||||||
|
<li><a href="{{/* get_taxonomy_url(kind="yourtaxonomynameplural", name=yourtaxonomyname) | safe */}}" >{{/* yourtaxonomyname */}}</a></li>
|
||||||
|
{%/* endfor */%}
|
||||||
|
</ul>
|
||||||
|
{%/* endif */%}
|
||||||
|
```
|
||||||
|
|
||||||
|
Done. I told you Zola is amazing :)
|
||||||
|
|
||||||
|
Anyway you can rewrite theme for your own wishes with Zola ([link to documentation](https://www.getzola.org/documentation/getting-started/installation/))
|
||||||
|
|
||||||
|
|
||||||
119
docs/content/themes/even/index.md
Normal file
119
docs/content/themes/even/index.md
Normal file
|
|
@ -0,0 +1,119 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "even"
|
||||||
|
description = "A robust, elegant dark theme"
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://github.com/getzola/even.git"
|
||||||
|
homepage = "https://github.com/getzola/even"
|
||||||
|
minimum_version = "0.11.0"
|
||||||
|
license = "MIT"
|
||||||
|
demo = "https://zola-even.netlify.com"
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "Vincent Prouillet"
|
||||||
|
homepage = "https://www.vincentprouillet.com"
|
||||||
|
+++
|
||||||
|
|
||||||
|
# Even
|
||||||
|
Even is a clean, responsive theme based on the Hugo theme with the same name featuring categories, tags and pagination.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Contents
|
||||||
|
|
||||||
|
- [Installation](#installation)
|
||||||
|
- [Options](#options)
|
||||||
|
- [Top menu](#top-menu)
|
||||||
|
- [Title](#title)
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
First download this theme to your `themes` directory:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ cd themes
|
||||||
|
$ git clone https://github.com/getzola/even.git
|
||||||
|
```
|
||||||
|
and then enable it in your `config.toml`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
theme = "even"
|
||||||
|
```
|
||||||
|
|
||||||
|
The theme requires tags and categories taxonomies to be enabled in your `config.toml`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
taxonomies = [
|
||||||
|
# You can enable/disable RSS
|
||||||
|
{name = "categories", rss = true},
|
||||||
|
{name = "tags", rss = true},
|
||||||
|
]
|
||||||
|
```
|
||||||
|
If you want to paginate taxonomies pages, you will need to overwrite the templates
|
||||||
|
as it only works for non-paginated taxonomies by default.
|
||||||
|
|
||||||
|
It also requires to put the posts in the root of the `content` folder and to enable pagination, for example in `content/_index.md`:
|
||||||
|
|
||||||
|
```
|
||||||
|
+++
|
||||||
|
paginate_by = 5
|
||||||
|
sort_by = "date"
|
||||||
|
+++
|
||||||
|
```
|
||||||
|
|
||||||
|
## Options
|
||||||
|
|
||||||
|
### Top-menu
|
||||||
|
Set a field in `extra` with a key of `even_menu`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# This is the default menu
|
||||||
|
even_menu = [
|
||||||
|
{url = "$BASE_URL", name = "Home"},
|
||||||
|
{url = "$BASE_URL/categories", name = "Categories"},
|
||||||
|
{url = "$BASE_URL/tags", name = "Tags"},
|
||||||
|
{url = "$BASE_URL/about", name = "About"},
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
If you put `$BASE_URL` in a url, it will automatically be replaced by the actual
|
||||||
|
site URL.
|
||||||
|
|
||||||
|
### Title
|
||||||
|
The site title is shown on the header. As it might be different from the `<title>`
|
||||||
|
element that the `title` field in the config represents, you can set the `even_title`
|
||||||
|
instead.
|
||||||
|
|
||||||
|
### KaTeX math formula support
|
||||||
|
|
||||||
|
This theme contains math formula support using [KaTeX](https://katex.org/),
|
||||||
|
which can be enabled by setting `katex_enable = true` in the `extra` section
|
||||||
|
of `config.toml`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
katex_enable = 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 \\)` inline and `\\[ \KaTeX \\]` / `$$ \KaTeX $$`
|
||||||
|
block-style automatic rendering is also supported, if enabled in the config:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
katex_enable = true
|
||||||
|
katex_auto_render = true
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
91
docs/content/themes/feather/index.md
Normal file
91
docs/content/themes/feather/index.md
Normal file
|
|
@ -0,0 +1,91 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "feather"
|
||||||
|
description = "A modern blog theme"
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://github.com/piedoom/feather"
|
||||||
|
homepage = "https://github.com/piedoom/feather"
|
||||||
|
minimum_version = "0.5.1"
|
||||||
|
license = "MIT"
|
||||||
|
demo = ""
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "doomy"
|
||||||
|
homepage = "https://alexanderlozada.com"
|
||||||
|
+++
|
||||||
|
|
||||||
|
# feather
|
||||||
|
A lightweight theme for zola
|
||||||
|
|
||||||
|
Feather is a blog theme specifically designed for the static site generator [Zola](https://www.getzola.org/). It's as far as
|
||||||
|
I know the first theme for the platform that isn't a port or just contained within template files.
|
||||||
|
|
||||||
|
Feather is *not* intended for anything other than blogs.
|
||||||
|
|
||||||
|
# Developing & Contributing
|
||||||
|
Because feather comes with example content, you can run the theme just like any Gutenberg
|
||||||
|
blog with `zola serve`. Your changes will autoreload!
|
||||||
|
|
||||||
|
## Considerations
|
||||||
|
Please don't edit the `content` folder directly for your own blog, use it as a theme like
|
||||||
|
intended!
|
||||||
|
|
||||||
|
# Usage
|
||||||
|
Using feather is easy. Install [Zola](https://www.getzola.org/) and follow
|
||||||
|
[the guide for creating a site and using a theme](https://www.getzola.org/documentation/themes/installing-and-using-themes/). Then,
|
||||||
|
add `theme = "feather"` to your `config.toml` file.
|
||||||
|
|
||||||
|
If you intend to publish your site to Github Pages, please check out [this tutorial](http://vaporsoft.net/publishing-gutenberg-to-github/).
|
||||||
|
|
||||||
|
## Options
|
||||||
|
Zola allows themes to [define `[extra]` variables](https://www.getzola.org/documentation/getting-started/configuration/)
|
||||||
|
in the config. Here's a full list of theme variables with example values and comments.
|
||||||
|
|
||||||
|
```
|
||||||
|
[extra]
|
||||||
|
# specify an image for the big header at the top of the page.
|
||||||
|
# this will be a background cover image, so make it large enough
|
||||||
|
# so that it won't upscale enough to pixelate
|
||||||
|
feather_header_image = "/theme_images/default.gif"
|
||||||
|
|
||||||
|
# if you want comments, add your disqus embed code here.
|
||||||
|
# you can obtain a code on the disqus website.
|
||||||
|
feather_disqus_code = "<div id='disqus_thread'></div><script> var disqus_config = ... etc ... etc ..."
|
||||||
|
|
||||||
|
# if you'd like people to be able to donate to you, you can include a donate link
|
||||||
|
# to be displayed in the footer of the website.
|
||||||
|
feather_donate_link = "https://paypal.me/piedoomy"
|
||||||
|
|
||||||
|
# if you want analytics, add your tracking code HTML here.
|
||||||
|
feather_analytics = "<script async src='https://www.googletagmanager.com/gtag/... etc ... etc ..."
|
||||||
|
```
|
||||||
|
|
||||||
|
## Features
|
||||||
|
Feather also provides several features optional.
|
||||||
|
|
||||||
|
- [x] Categories page
|
||||||
|
- [x] Tags page
|
||||||
|
- [x] Sorting chronologically
|
||||||
|
- [x] Comments
|
||||||
|
- [x] Analytics
|
||||||
|
- [x] Donate links
|
||||||
|
|
||||||
|
## Using Categories and Tags
|
||||||
|
In order to use categories and tags, you'll need to enable their compilation by adding the following lines to your `config.toml`
|
||||||
|
(make sure they aren't under `[extra]`):
|
||||||
|
|
||||||
|
```toml
|
||||||
|
generate_categories_pages = true
|
||||||
|
generate_tags_pages = true
|
||||||
|
```
|
||||||
|
|
||||||
|
# Live demo
|
||||||
|
[My dev site](http://vaporsoft.net/) uses the latest version of feather.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
145
docs/content/themes/float/index.md
Normal file
145
docs/content/themes/float/index.md
Normal file
|
|
@ -0,0 +1,145 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "Float"
|
||||||
|
description = "An elegant blog theme"
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://gitlab.com/float-theme/float.git"
|
||||||
|
homepage = "https://float-theme.netlify.app/"
|
||||||
|
minimum_version = "0.11.0"
|
||||||
|
license = "MIT"
|
||||||
|
demo = ""
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "Leon"
|
||||||
|
homepage = "https://exp2.uniuni.space/"
|
||||||
|
+++
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
**[English](README.en.md)**
|
||||||
|
|
||||||
|
Float 是一款為 [Zola](https://www.getzola.org/) 設計的佈景主題。
|
||||||
|
|
||||||
|
[[_TOC_]]
|
||||||
|
|
||||||
|
## 特色
|
||||||
|
|
||||||
|
- 依據不同的螢幕尺寸提供最佳化版面，從小尺寸到大尺寸都可獲得優秀的閱讀體驗。
|
||||||
|
- 文章卡片提供兩種卡片尺寸，重點文章可採用更醒目的寬版卡片。
|
||||||
|
- 文章卡片配圖可自行指定，未指定者使用 [Unsplash Source](https://source.unsplash.com/) 的隨機圖片。
|
||||||
|
- 使用 Zola 的 `resize_image()` 自動產生適用於 DPR 1.0 ~ 3.0 的圖片，卡片配圖會由瀏覽器依據設備之 DPR 自動選用最佳尺寸的圖片。
|
||||||
|
- 圖片啟用延遲載入，縮短頁面載入時間。
|
||||||
|
- 預設埋入 HTML SEO 標籤、[Open Graph](https://ogp.me/) 與 [Twitter Cards](https://developer.twitter.com/en/docs/tweets/optimize-with-cards/overview/abouts-cards) 標籤。
|
||||||
|
- 整合 [Google Analytics](https://analytics.google.com/)。
|
||||||
|
- 整合 [Google AdSense](https://adsense.google.com/)。
|
||||||
|
- 版面為 [AdSense 自動廣告](https://support.google.com/adsense/answer/9261306)最佳化，不會因自動廣告的寬度不一而破版。
|
||||||
|
- 整合 [LikeCoin](https://like.co/)。
|
||||||
|
- 整合 [utterances](https://utteranc.es/)，利用 [GitHub](https://github.com/) issue 作為留言系統。
|
||||||
|
|
||||||
|
## 安裝與啟用
|
||||||
|
|
||||||
|
在您的 Zola 專案資料夾內：
|
||||||
|
|
||||||
|
```shell
|
||||||
|
cd themes
|
||||||
|
git clone git@gitlab.com:float-theme/float.git
|
||||||
|
```
|
||||||
|
|
||||||
|
編輯您的 config.toml，指定 Float 作為佈景主題：
|
||||||
|
|
||||||
|
```TOML
|
||||||
|
theme = "float"
|
||||||
|
```
|
||||||
|
|
||||||
|
編輯您的 config.toml，加入 tags 作為分類系統：
|
||||||
|
|
||||||
|
```TOML
|
||||||
|
taxonomies = [
|
||||||
|
{name = "tags", paginate_by = 10},
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
複製 float/static/ 的所有子資料夾與檔案到您的 static/：
|
||||||
|
|
||||||
|
```shell
|
||||||
|
cp -r themes/float/static/* static/
|
||||||
|
```
|
||||||
|
|
||||||
|
複製 float/content/ 的所有子資料夾與檔案到您的 content/：
|
||||||
|
|
||||||
|
```shell
|
||||||
|
cp -r themes/float/content/* content/
|
||||||
|
```
|
||||||
|
|
||||||
|
## 使用 Float
|
||||||
|
|
||||||
|
### 文章與配圖
|
||||||
|
|
||||||
|
文章皆以資料夾的方式存在，如下例：
|
||||||
|
|
||||||
|
```
|
||||||
|
content/
|
||||||
|
└── blog/
|
||||||
|
└── 2020-06-21-Float theme for Zola/
|
||||||
|
├── index.md
|
||||||
|
├── pic1.png
|
||||||
|
├── pic2.png
|
||||||
|
└── qa_report.pdf
|
||||||
|
```
|
||||||
|
|
||||||
|
文章為 index.md，文內的配圖或其它檔案也是放在文章資料夾內。
|
||||||
|
|
||||||
|
### Front-matter
|
||||||
|
|
||||||
|
Front-matter 請參照下列註解說明：
|
||||||
|
|
||||||
|
```TOML
|
||||||
|
title = "Float theme for Zola"
|
||||||
|
description = "Float features and usage guide"
|
||||||
|
draft = false
|
||||||
|
[taxonomies]
|
||||||
|
tags = ["Float", "Zola"]
|
||||||
|
[extra]
|
||||||
|
feature_image = "pic1.png" # 卡片圖片。
|
||||||
|
feature = true # 是否為重點文章，重點文章會以寬版卡片顯示。
|
||||||
|
```
|
||||||
|
|
||||||
|
## 客製化
|
||||||
|
|
||||||
|
可客製化設定大多可以在 config.toml 的 `[extra]` 區段做設定：
|
||||||
|
|
||||||
|
```TOML
|
||||||
|
[extra]
|
||||||
|
copyright = ""
|
||||||
|
|
||||||
|
web_fonts = "<link rel='stylesheet' href='https://fonts.googleapis.com/css2?family=Noto+Serif+TC:wght@500;700&display=swap'>"
|
||||||
|
|
||||||
|
google_analytics = false
|
||||||
|
# google_analytics_id = "UA-XXXXXX-X"
|
||||||
|
|
||||||
|
google_adsense = false
|
||||||
|
# google_adsense_id = "ca-pub-XXXXXXXXXXXXXXXX"
|
||||||
|
|
||||||
|
twitter_account = "@xxx"
|
||||||
|
|
||||||
|
likecoin = false
|
||||||
|
# likecoin_name = "xxx"
|
||||||
|
|
||||||
|
utterances = false
|
||||||
|
# utterances_repo = "xxx/xxx"
|
||||||
|
```
|
||||||
|
|
||||||
|
### 字體
|
||||||
|
|
||||||
|
字體的 CSS 位於 float/sass/font.scss，欲更換字體，把 float/sass/font.scss 複製到自己的 sass/font.scss，並修改之。
|
||||||
|
|
||||||
|
## 已知問題
|
||||||
|
|
||||||
|
- 分頁設定皆須設為 10 篇分頁。因為 Zola 的 `get_section()` 無法取得該 section 的分頁設定。
|
||||||
|
|
||||||
|
|
||||||
136
docs/content/themes/hallo/index.md
Normal file
136
docs/content/themes/hallo/index.md
Normal file
|
|
@ -0,0 +1,136 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "hallo"
|
||||||
|
description = "A single-page theme to introduce yourself."
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://github.com/flyingP0tat0/zola-hallo.git"
|
||||||
|
homepage = "https://github.com/janbaudisch/zola-hallo"
|
||||||
|
minimum_version = "0.4.0"
|
||||||
|
license = "MIT"
|
||||||
|
demo = "https://zola-hallo.janbaudisch.dev"
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "Jan Baudisch"
|
||||||
|
homepage = "https://janbaudisch.dev"
|
||||||
|
+++
|
||||||
|
|
||||||
|
[![Build Status][build-img]][build-url]
|
||||||
|
[![Demo][demo-img]][demo-url]
|
||||||
|
|
||||||
|
# Hallo
|
||||||
|
|
||||||
|
> A single-page theme to introduce yourself.
|
||||||
|
>
|
||||||
|
> [Zola][zola] port of [hallo-hugo][hallo-hugo].
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Original
|
||||||
|
|
||||||
|
This is a port of the original [hallo-hugo][hallo-hugo] theme for Hugo ([License][upstream-license]).
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
The easiest way to install this theme is to either clone it ...
|
||||||
|
|
||||||
|
```
|
||||||
|
git clone https://github.com/janbaudisch/zola-hallo.git themes/hallo
|
||||||
|
```
|
||||||
|
|
||||||
|
... or to use it as a submodule.
|
||||||
|
|
||||||
|
```
|
||||||
|
git submodule add https://github.com/janbaudisch/zola-hallo.git themes/hallo
|
||||||
|
```
|
||||||
|
|
||||||
|
Either way, you will have to enable the theme in your `config.toml`.
|
||||||
|
|
||||||
|
```toml
|
||||||
|
theme = "hallo"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Introduction
|
||||||
|
|
||||||
|
The introduction text is included from `templates/partials/introduction.html`.
|
||||||
|
|
||||||
|
You will need to create this file and fill it with content.
|
||||||
|
|
||||||
|
|
||||||
|
## Options
|
||||||
|
|
||||||
|
See [`config.toml`][config] for an example configuration.
|
||||||
|
|
||||||
|
### Author
|
||||||
|
|
||||||
|
The given name will be used for the 'I am ...' text.
|
||||||
|
|
||||||
|
Default: `Hallo`
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra.author]
|
||||||
|
name = "Hallo"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Greeting
|
||||||
|
|
||||||
|
The string will be used as a greeting.
|
||||||
|
|
||||||
|
Default: `Hello!`
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
greeting = "Hello!"
|
||||||
|
```
|
||||||
|
|
||||||
|
### `iam`
|
||||||
|
|
||||||
|
This variable defines the `I am` text, which you may want to swap out for another language.
|
||||||
|
|
||||||
|
Default: `I am`
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
iam = "I am"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Links
|
||||||
|
|
||||||
|
Links show up below the introduction. They are styled with [Font Awesome][fontawesome], you may optionally choose the iconset (default is [brands][fontawesome-brands]).
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
links = [
|
||||||
|
{ title = "E-Mail", url = "mailto:mail@example.org", iconset = "fas", icon = "envelope" },
|
||||||
|
{ title = "GitHub", url = "https://github.com", icon = "github" },
|
||||||
|
{ title = "Twitter", url = "https://twitter.com", icon = "twitter" }
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Theme
|
||||||
|
|
||||||
|
Change the colors used.
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra.theme]
|
||||||
|
background = "#6FCDBD"
|
||||||
|
foreground = "#FFF" # text and portrait border
|
||||||
|
hover = "#333" # link hover
|
||||||
|
```
|
||||||
|
|
||||||
|
[build-img]: https://builds.sr.ht/~janbaudisch/zola-hallo.svg
|
||||||
|
[build-url]: https://builds.sr.ht/~janbaudisch/zola-hallo
|
||||||
|
[demo-img]: https://img.shields.io/badge/demo-live-green.svg
|
||||||
|
[demo-url]: https://zola-hallo.janbaudisch.dev
|
||||||
|
[zola]: https://www.getzola.org
|
||||||
|
[hallo-hugo]: https://github.com/EmielH/hallo-hugo
|
||||||
|
[fontawesome]: https://fontawesome.com
|
||||||
|
[fontawesome-brands]: https://fontawesome.com/icons?d=gallery&s=brands&m=free
|
||||||
|
[upstream-license]: https://github.com/janbaudisch/zola-hallo/blob/master/upstream/LICENSE
|
||||||
|
[config]: https://github.com/janbaudisch/zola-hallo/blob/master/config.toml
|
||||||
|
|
||||||
|
|
||||||
90
docs/content/themes/hyde/index.md
Normal file
90
docs/content/themes/hyde/index.md
Normal file
|
|
@ -0,0 +1,90 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "hyde"
|
||||||
|
description = "A classic blog theme"
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://github.com/getzola/hyde.git"
|
||||||
|
homepage = "https://github.com/getzola/hyde"
|
||||||
|
minimum_version = "0.11.0"
|
||||||
|
license = "MIT"
|
||||||
|
demo = "https://zola-hyde.netlify.com"
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "Vincent Prouillet"
|
||||||
|
homepage = "https://www.vincentprouillet.com"
|
||||||
|
+++
|
||||||
|
|
||||||
|
# hyde
|
||||||
|
Hyde is a brazen two-column [Zola](https://github.com/getzola/zola) based on the Jekyll theme of the same name that pairs a prominent sidebar with uncomplicated content.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Contents
|
||||||
|
|
||||||
|
- [Installation](#installation)
|
||||||
|
- [Options](#options)
|
||||||
|
- [Sidebar menu](#sidebar-menu)
|
||||||
|
- [Sticky sidebar content](#sticky-sidebar-content)
|
||||||
|
- [Themes](#themes)
|
||||||
|
- [Reverse layout](#reverse-layout)
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
First download this theme to your `themes` directory:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ cd themes
|
||||||
|
$ git clone https://github.com/getzola/hyde.git
|
||||||
|
```
|
||||||
|
and then enable it in your `config.toml`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
theme = "hyde"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Options
|
||||||
|
|
||||||
|
### Sidebar menu
|
||||||
|
Set a field in `extra` with a key of `hyde_links`:
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
hyde_links = [
|
||||||
|
{url = "https://google.com", name = "Google.com"},
|
||||||
|
{url = "https://google.fr", name = "Google.fr"},
|
||||||
|
]
|
||||||
|
```
|
||||||
|
Each link needs to have a `url` and a `name`.
|
||||||
|
|
||||||
|
### Sticky sidebar content
|
||||||
|
By default Hyde ships with a sidebar that affixes it's content to the bottom of the sidebar. You can optionally disable this by setting `hyde_sticky` to false in your `config.toml`.
|
||||||
|
|
||||||
|
### Themes
|
||||||
|
Hyde ships with eight optional themes based on the [base16 color scheme](https://github.com/chriskempson/base16). Apply a theme to change the color scheme (mostly applies to sidebar and links).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
There are eight themes available at this time.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
To use a theme, set the `hyde_theme` field in `config.toml` to any of the themes name:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
hyde_theme = "theme-base-08"
|
||||||
|
```
|
||||||
|
|
||||||
|
To create your own theme, look to the Themes section of [included CSS file](https://github.com/poole/hyde/blob/master/public/css/hyde.css). Copy any existing theme (they're only a few lines of CSS), rename it, and change the provided colors.
|
||||||
|
|
||||||
|
### Reverse layout
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Hyde's page orientation can be reversed by setting `hyde_reverse` to `true` in the `config.toml`.
|
||||||
|
|
||||||
|
|
||||||
129
docs/content/themes/juice/index.md
Normal file
129
docs/content/themes/juice/index.md
Normal file
|
|
@ -0,0 +1,129 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "juice"
|
||||||
|
description = "An intuitive, elegant, and lightweight Zola™ theme for product sites."
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://github.com/huhu/juice"
|
||||||
|
homepage = "https://github.com/huhu/juice"
|
||||||
|
minimum_version = "0.11.0"
|
||||||
|
license = "MIT"
|
||||||
|
demo = "https://juice.huhu.io"
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "Huhu teams"
|
||||||
|
homepage = "https://huhu.io"
|
||||||
|
+++
|
||||||
|
|
||||||
|
# Juice
|
||||||
|
|
||||||
|
<img align="right" width="150" height="150" src="/static/juice.svg">
|
||||||
|
|
||||||
|
**Juice** is an intuitive, elegant, and responsive Zola™ theme for product sites.
|
||||||
|
|
||||||
|
- Build for product sites
|
||||||
|
- Simple and intuitive structure
|
||||||
|
- Clean and elegant design
|
||||||
|
- Responsive and mobile device compatible
|
||||||
|
- Customize and extend friendly
|
||||||
|
|
||||||
|
https://juice.huhu.io
|
||||||
|
|
||||||
|
# Installation
|
||||||
|
|
||||||
|
First download this theme to your `themes` directory:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ cd themes
|
||||||
|
$ git clone https://github.com/huhu/juice.git
|
||||||
|
```
|
||||||
|
|
||||||
|
or add as a submodule
|
||||||
|
```bash
|
||||||
|
$ git submodule add https://github.com/huhu/juice themes/juice
|
||||||
|
```
|
||||||
|
|
||||||
|
and then enable it in your `config.toml`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
theme = "juice"
|
||||||
|
```
|
||||||
|
|
||||||
|
# Structure
|
||||||
|
|
||||||
|
### Hero
|
||||||
|
|
||||||
|
**Juice** is designed for product websites, hence we let **hero** part fills whole of screen.
|
||||||
|
You can customize your **hero** by using `hero` block in the `index.html`.
|
||||||
|
|
||||||
|
```html
|
||||||
|
{%/* block hero */%}
|
||||||
|
<div>
|
||||||
|
Your cool hero html...
|
||||||
|
</div>
|
||||||
|
{%/* endblock hero */%}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Page
|
||||||
|
|
||||||
|
Every markdown file located in `content` directory will become a **Page**. There also will display as
|
||||||
|
a navigate link on the top-right corner.
|
||||||
|
You can change the frontmatter's `weight` value to sort the order (ascending order).
|
||||||
|
|
||||||
|
```
|
||||||
|
+++
|
||||||
|
title = "Changelog"
|
||||||
|
description = "Changelog"
|
||||||
|
weight = 3
|
||||||
|
+++
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
### CSS variables
|
||||||
|
|
||||||
|
You can override theme variable by creating a file named `_variables.html` in your `templates` directory.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<style>
|
||||||
|
:root {
|
||||||
|
/* Primary theme color */
|
||||||
|
--primary-color: #FED43F;
|
||||||
|
/* Primary theme text color */
|
||||||
|
--primary-text-color: #543631;
|
||||||
|
/* Primary theme link color */
|
||||||
|
--primary-link-color: #F9BB2D;
|
||||||
|
/* Secondary color: the background body color */
|
||||||
|
--secondary-color: #fcfaf6;
|
||||||
|
--secondary-text-color: #303030;
|
||||||
|
/* Highlight text color of table of content */
|
||||||
|
--toc-highlight-text-color: #d46e13;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
```
|
||||||
|
|
||||||
|
# Configuration
|
||||||
|
|
||||||
|
You can customize some builtin property in `config.toml` file:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
juice_logo_name = "Juice"
|
||||||
|
juice_logo_path = "juice.svg"
|
||||||
|
juice_extra_menu = [
|
||||||
|
{ title = "Github", link = "https://github.com/huhu/juice"}
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
# Contributing
|
||||||
|
|
||||||
|
Thank you very much for considering contributing to this project!
|
||||||
|
|
||||||
|
We appreciate any form of contribution:
|
||||||
|
|
||||||
|
- New issues (feature requests, bug reports, questions, ideas, ...)
|
||||||
|
- Pull requests (documentation improvements, code improvements, new features, ...)
|
||||||
|
|
||||||
150
docs/content/themes/lightspeed/index.md
Normal file
150
docs/content/themes/lightspeed/index.md
Normal file
|
|
@ -0,0 +1,150 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "lightspeed"
|
||||||
|
description = "Zola theme with a perfect Lighthouse score"
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://github.com/carpetscheme/lightspeed"
|
||||||
|
homepage = "https://github.com/carpetscheme/lightspeed"
|
||||||
|
minimum_version = "0.10.0"
|
||||||
|
license = "MIT"
|
||||||
|
demo = "https://quirky-perlman-34d0da.netlify.com/"
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "El Carpet"
|
||||||
|
homepage = "https://github.com/carpetscheme"
|
||||||
|
+++
|
||||||
|
|
||||||
|
# Light Speed
|
||||||
|
|
||||||
|
An insanely fast and performance-based Zola theme, ported from [Light Speed Jekyll](https://github.com/bradleytaunt/lightspeed).
|
||||||
|
|
||||||
|
Some fun facts about the theme:
|
||||||
|
|
||||||
|
* Perfect score on Google's Lighthouse audit
|
||||||
|
* Only ~700 bytes of CSS
|
||||||
|
* No JavaScript
|
||||||
|
* Now with SEO!
|
||||||
|
|
||||||
|
Demo: [quirky-perlman-34d0da.netlify.com](https://quirky-perlman-34d0da.netlify.com)
|
||||||
|
|
||||||
|
-----
|
||||||
|
|
||||||
|
## Contents
|
||||||
|
|
||||||
|
- [Installation](#installation)
|
||||||
|
- [Options](#options)
|
||||||
|
- [Title](#title)
|
||||||
|
- [Footer menu](#footer-menu)
|
||||||
|
- [SEO](#seo)
|
||||||
|
- [Footer text](#footer-text)
|
||||||
|
- [Sass](#Sass)
|
||||||
|
- [Original](#original)
|
||||||
|
- [License](#license)
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
First download this theme to your `themes` directory:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ cd themes
|
||||||
|
$ git clone https://github.com/carpetscheme/lightspeed.git
|
||||||
|
```
|
||||||
|
and then enable it in your `config.toml`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
theme = "lightspeed"
|
||||||
|
```
|
||||||
|
|
||||||
|
Posts should be placed directly in the `content` folder.
|
||||||
|
|
||||||
|
To sort the post index by date, enable sort in your index section `content/_index.md`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
sort_by = "date"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Options
|
||||||
|
|
||||||
|
### Title
|
||||||
|
Set a title and description in the config to appear in the site header:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
title = "Different strokes"
|
||||||
|
description = "for different folks"
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
### Footer-menu
|
||||||
|
Set a field in `extra` with a key of `footer_links`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
|
||||||
|
footer_links = [
|
||||||
|
{url = "$BASE_URL/about", name = "About"},
|
||||||
|
{url = "$BASE_URL/atom.xml", name = "RSS"},
|
||||||
|
{url = "https://google.com", name = "Google"},
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
If you put `$BASE_URL` in a url, it will automatically be replaced by the actual
|
||||||
|
site URL.
|
||||||
|
|
||||||
|
Create pages such as `$BASE_URL/about` by placing them in a subfolder of the content directory, and specifying the path in the frontmatter:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
path = "about"
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEO
|
||||||
|
|
||||||
|
Most SEO tags are populated by the page metadata, but you can set the `author` and for the `og:image` tag provide the path to an image:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
|
||||||
|
author = "Grant Green"
|
||||||
|
ogimage = "Greenery.png"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Footer-text
|
||||||
|
|
||||||
|
By default the footer provides links to Zola and Netlify, and a tagline of "Maintained with :heart: for the web".
|
||||||
|
To disable any of those parts, and/or add a custom tagline of your own, the following options are available:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
|
||||||
|
zola = true
|
||||||
|
netlify = false
|
||||||
|
maintained_with_love = false
|
||||||
|
footer_tagline = "What if everything is an illusion and nothing exists? In that case, I definitely overpaid for my carpet."
|
||||||
|
```
|
||||||
|
|
||||||
|
### Sass
|
||||||
|
|
||||||
|
Styles are compiled from sass and imported inline to the header :zap:
|
||||||
|
|
||||||
|
You can overide the styles by enabling sass compilation in the config:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
compile_sass = true
|
||||||
|
```
|
||||||
|
|
||||||
|
...and placing a replacement `style.scss` file in your sass folder.
|
||||||
|
|
||||||
|
## Original
|
||||||
|
This template is based on the Jekyll template [Light Speed Jekyll](https://github.com/bradleytaunt/lightspeed) by Bradley Taunt.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Open sourced under the [MIT license](LICENSE.md).
|
||||||
|
|
||||||
|
This project is open source except for example articles found in `content`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
67
docs/content/themes/oceanic-zen/index.md
Normal file
67
docs/content/themes/oceanic-zen/index.md
Normal file
|
|
@ -0,0 +1,67 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "Oceanic Zen"
|
||||||
|
description = "Minimalistic blog theme"
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://github.com/barlog-m/oceanic-zen.git"
|
||||||
|
homepage = "https://github.com/barlog-m/oceanic-zen"
|
||||||
|
minimum_version = "0.9.0"
|
||||||
|
license = "MIT"
|
||||||
|
demo = ""
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "Barlog M."
|
||||||
|
homepage = "https://barlog.li"
|
||||||
|
+++
|
||||||
|
|
||||||
|
# Oceanic Zen
|
||||||
|
|
||||||
|
[](https://app.netlify.com/sites/oceanic-zen/deploys)
|
||||||
|
|
||||||
|
Oceanic Zen is a theme for [Zola](https://www.getzola.org/) static site generator
|
||||||
|
|
||||||
|
[Oceanic Zen](https://oceanic-zen.netlify.app/) is a minimalistic theme for personal blog.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
Download theme to your `themes` directory:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ cd themes
|
||||||
|
$ git clone https://github.com/barlog-m/oceanic-zen.git
|
||||||
|
```
|
||||||
|
|
||||||
|
Or add as git submodule
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ git submodule add https://github.com/barlog-m/oceanic-zen.git themes/oceanic-zen
|
||||||
|
```
|
||||||
|
|
||||||
|
Enable it in your `config.toml`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
theme = "oceanic-zen"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Options
|
||||||
|
|
||||||
|
Theme supported some extra options
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
author = "blog author name"
|
||||||
|
github = "github author name"
|
||||||
|
twitter = "twitter author name"
|
||||||
|
```
|
||||||
|
|
||||||
|
Font [Iosevka](https://typeof.net/Iosevka/)
|
||||||
|
|
||||||
|
|
||||||
168
docs/content/themes/sam/index.md
Normal file
168
docs/content/themes/sam/index.md
Normal file
|
|
@ -0,0 +1,168 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "sam"
|
||||||
|
description = "A Simple and Minimalist theme with a focus on typography and content."
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://github.com/janbaudisch/zola-sam.git"
|
||||||
|
homepage = "https://github.com/janbaudisch/zola-sam"
|
||||||
|
minimum_version = "0.4.0"
|
||||||
|
license = "AGPL-3.0"
|
||||||
|
demo = "https://zola-sam.janbaudisch.dev"
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "Jan Baudisch"
|
||||||
|
homepage = "https://janbaudisch.dev"
|
||||||
|
+++
|
||||||
|
|
||||||
|
[![Build Status][build-img]][build-url]
|
||||||
|
[![Demo][demo-img]][demo-url]
|
||||||
|
|
||||||
|
# Sam
|
||||||
|
|
||||||
|
> A Simple and Minimalist theme with a focus on typography and content.
|
||||||
|
>
|
||||||
|
> [Zola][zola] port of [hugo-theme-sam][hugo-sam].
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Original
|
||||||
|
|
||||||
|
This is a port of the original [hugo-theme-sam][hugo-sam] theme for Hugo ([License][upstream-license]).
|
||||||
|
|
||||||
|
See [`upstream`][upstream] for source code take from there.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
The easiest way to install this theme is to either clone it ...
|
||||||
|
|
||||||
|
```
|
||||||
|
git clone https://github.com/janbaudisch/zola-sam.git themes/sam
|
||||||
|
```
|
||||||
|
|
||||||
|
... or to use it as a submodule.
|
||||||
|
|
||||||
|
```
|
||||||
|
git submodule add https://github.com/janbaudisch/zola-sam.git themes/sam
|
||||||
|
```
|
||||||
|
|
||||||
|
Either way, you will have to enable the theme in your `config.toml`.
|
||||||
|
|
||||||
|
```toml
|
||||||
|
theme = "sam"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Options
|
||||||
|
|
||||||
|
See [`config.toml`][config] for an example configuration.
|
||||||
|
|
||||||
|
### Menu
|
||||||
|
|
||||||
|
The menu on the index page is created as follows: If the `sam_menu` variable is set, it gets used.
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
sam_menu = [
|
||||||
|
{ text = "posts", link = "/posts" },
|
||||||
|
{ text = "about", link = "/about" },
|
||||||
|
{ text = "github", link = "https://github.com" }
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
If it is not set, all sections under `content` will get linked.
|
||||||
|
|
||||||
|
#### Bottom menu
|
||||||
|
|
||||||
|
This variable decides wether the menu - as mentioned above - will also be displayed at the bottom of pages.
|
||||||
|
|
||||||
|
Default: `false`
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
sam_bottom_menu = true
|
||||||
|
```
|
||||||
|
|
||||||
|
### `home`
|
||||||
|
|
||||||
|
Sets the name for all links referring to the home page in the menus and the 404 page.
|
||||||
|
|
||||||
|
Default: `home`
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
home = "home"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Date format
|
||||||
|
|
||||||
|
Specifies how to display dates. The format is described [here][date-format-docs].
|
||||||
|
|
||||||
|
Default: `%a %b %e, %Y`
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
date_format = "%a %b %e, %Y"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Word count and reading time
|
||||||
|
|
||||||
|
You can enable or disable word count and reading time for posts across the whole site:
|
||||||
|
|
||||||
|
Default: `true` (both)
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
show_word_count = true
|
||||||
|
show_reading_time = true
|
||||||
|
```
|
||||||
|
|
||||||
|
If enabled, you can opt-out per page via front-matter:
|
||||||
|
|
||||||
|
Default: `false` (both)
|
||||||
|
|
||||||
|
```
|
||||||
|
+++
|
||||||
|
[extra]
|
||||||
|
hide_word_count = true
|
||||||
|
hide_reading_time = true
|
||||||
|
+++
|
||||||
|
```
|
||||||
|
|
||||||
|
### Disable page header
|
||||||
|
|
||||||
|
If you want to disable the complete header of a page (for example a page which is explicitly not a post), you can do so via front-matter:
|
||||||
|
|
||||||
|
Default: `false`
|
||||||
|
|
||||||
|
```
|
||||||
|
+++
|
||||||
|
[extra]
|
||||||
|
no_header = true
|
||||||
|
+++
|
||||||
|
```
|
||||||
|
|
||||||
|
### Footer
|
||||||
|
|
||||||
|
To place some text at the end of pages, set the following:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra.sam_footer]
|
||||||
|
text = "Some footer text."
|
||||||
|
```
|
||||||
|
|
||||||
|
[build-img]: https://builds.sr.ht/~janbaudisch/zola-sam.svg
|
||||||
|
[build-url]: https://builds.sr.ht/~janbaudisch/zola-sam
|
||||||
|
[demo-img]: https://img.shields.io/badge/demo-live-green.svg
|
||||||
|
[demo-url]: https://zola-sam.janbaudisch.dev
|
||||||
|
[zola]: https://getzola.org
|
||||||
|
[hugo-sam]: https://github.com/victoriadotdev/hugo-theme-sam
|
||||||
|
[upstream]: https://github.com/janbaudisch/zola-sam/blob/master/upstream
|
||||||
|
[upstream-license]: https://github.com/janbaudisch/zola-sam/blob/master/upstream/LICENSE
|
||||||
|
[config]: https://github.com/janbaudisch/zola-sam/blob/master/config.toml
|
||||||
|
[date-format-docs]: https://docs.rs/chrono/latest/chrono/format/strftime/index.html
|
||||||
|
|
||||||
|
|
||||||
90
docs/content/themes/simple-dev-blog/index.md
Normal file
90
docs/content/themes/simple-dev-blog/index.md
Normal file
|
|
@ -0,0 +1,90 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "simple-dev-blog"
|
||||||
|
description = "A simple dev blog theme with no javascript, prerendered linked pages and SEO tags."
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01: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"
|
||||||
|
license = "MIT"
|
||||||
|
demo = "https://simple-dev-blog-zola-starter.netlify.app/"
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "Bennett Hardwick"
|
||||||
|
homepage = "https://bennetthardwick.com/"
|
||||||
|
+++
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# simple-dev-blog-zola-starter
|
||||||
|
|
||||||
|
A simple dev-blog theme for Zola. It uses no JavaScript, prerenders links between navigation, blog posts and tags and adds common tags for SEO.
|
||||||
|
|
||||||
|
You can view it live [here](https://simple-dev-blog-zola-starter.netlify.app/).
|
||||||
|
|
||||||
|
## How to get started
|
||||||
|
|
||||||
|
To create a new Zola site, first download the CLI and install it on your system.
|
||||||
|
You can find installation instructions [on the Zola website](https://www.getzola.org/documentation/getting-started/installation/).
|
||||||
|
|
||||||
|
1. After you've installed the Zola CLI, run the following command to create a new site:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
zola init my_amazing_site
|
||||||
|
cd my_amazing_site
|
||||||
|
```
|
||||||
|
|
||||||
|
2. After you've created the site, install the "Simple Dev Blog" theme like so:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git clone --depth=1 \
|
||||||
|
https://github.com/bennetthardwick/simple-dev-blog-zola-starter \
|
||||||
|
themes/simple-dev-blog
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Now in your `config.toml` file, choose the theme by setting `theme = "simple-dev-blog"`.
|
||||||
|
|
||||||
|
4. This theme uses the `tags` taxonomy, in your `config.toml` file set `taxonomies = [ { name = "tags" } ]`
|
||||||
|
|
||||||
|
5. Copy across the default content from the theme by running `cp themes/simple-dev-blog/content/* ./content -r`
|
||||||
|
|
||||||
|
6. That's it! Now build your site by running the following command, and navigate to `127.0.0.1:111`:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
zola serve
|
||||||
|
```
|
||||||
|
|
||||||
|
You should now have a speedy simple dev blog up and running, have fun!
|
||||||
|
|
||||||
|
## Customisation
|
||||||
|
|
||||||
|
Look at the `config.toml` and `theme.toml` in this repo for an idea, here's a list of all the options:
|
||||||
|
|
||||||
|
### Global
|
||||||
|
|
||||||
|
The following options should be under the `[extra]` in `config.toml`
|
||||||
|
|
||||||
|
- `accent_light` - a lighter shade of your site's accent color
|
||||||
|
- `accent` - your site's accent color
|
||||||
|
- `blog_path` - the path to your blog (defaults to `blog`)
|
||||||
|
- `default_og_image` - the path default og:image for your page
|
||||||
|
- `footer_about` - the content for your footer in markdown
|
||||||
|
- `icon` - the path to the icon for your site in the content folder
|
||||||
|
- E.g to add the file `icon.png` you should put it in `content/icon.png`
|
||||||
|
- `nav` - see `theme.toml`, the navigation links for your site
|
||||||
|
- `not_found_message` - the content for your 404 page in markdown
|
||||||
|
- `profile_large` - the path to a larger vertical version of your profile picture in the content folder
|
||||||
|
- `profile_small` - the path to a small version of your profile picture in the content folder
|
||||||
|
|
||||||
|
### Page
|
||||||
|
|
||||||
|
The following options should be under the `[extra]` section of each page
|
||||||
|
|
||||||
|
- `thumbnail` - the path to your og:image for that page
|
||||||
|
|
||||||
|
|
||||||
71
docs/content/themes/slim/index.md
Normal file
71
docs/content/themes/slim/index.md
Normal file
|
|
@ -0,0 +1,71 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "Slim"
|
||||||
|
description = "Slim is a minimal, clean and beautiful theme for Zola."
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://github.com/jameshclrk/zola-slim"
|
||||||
|
homepage = "https://github.com/jameshclrk/zola-slim"
|
||||||
|
minimum_version = "0.8.0"
|
||||||
|
license = "MIT"
|
||||||
|
demo = "https://zola-slim.netlify.com"
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "James Clark"
|
||||||
|
homepage = "https://jamesclark.dev"
|
||||||
|
+++
|
||||||
|
|
||||||
|
# Slim
|
||||||
|
|
||||||
|
Slim is a minimal, clean and beautiful theme for [Zola](http://getzola.org/).
|
||||||
|
|
||||||
|
This theme was ported to Zola, the original is available at [zhe/hugo-theme-slim](https://github.com/zhe/hugo-theme-slim). It is excellent, thank you [zhe](https://github.com/zhe)!
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
[Demo](http://zola-slim.netlify.com).
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
```
|
||||||
|
cd themes
|
||||||
|
git clone https://github.com/jameshclrk/zola-slim slim
|
||||||
|
```
|
||||||
|
|
||||||
|
See the [official docs](https://www.getzola.org/documentation/themes/installing-and-using-themes/) for more information.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
Slim supports a `tags` taxonomy by default. This can be enabled by setting it in your `config.toml`:
|
||||||
|
|
||||||
|
```
|
||||||
|
taxonomies = [
|
||||||
|
{name = "tags", paginate_by = 5, rss = true}
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
There are a couple of extra options supported:
|
||||||
|
```
|
||||||
|
[extra]
|
||||||
|
# Show a summary of a post in a list
|
||||||
|
slim_summary = false
|
||||||
|
# Show the content of a post in a list
|
||||||
|
slim_content = false
|
||||||
|
# Links to show at the top of the menu
|
||||||
|
slim_menu = [
|
||||||
|
{url = "$BASE_URL/tags", name = "Tags"}
|
||||||
|
]
|
||||||
|
# Links to show at the bottom of the menu
|
||||||
|
slim_social = [
|
||||||
|
{url = "https://github.com/jameshclrk", name = "Github"}
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Open sourced under [MIT license](https://github.com/zhe/hugo-theme-slim/blob/master/LICENSE.md).
|
||||||
|
|
||||||
|
|
||||||
71
docs/content/themes/solar-theme-zola/index.md
Normal file
71
docs/content/themes/solar-theme-zola/index.md
Normal file
|
|
@ -0,0 +1,71 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "solar-theme-zola"
|
||||||
|
description = "A port of solar-theme-hugo for zola"
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://github.com/hulufei/solar-theme-zola.git"
|
||||||
|
homepage = "https://github.com/hulufei/solar-theme-zola"
|
||||||
|
minimum_version = "0.4.0"
|
||||||
|
license = "MIT"
|
||||||
|
demo = ""
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "hulufei"
|
||||||
|
homepage = "https://github/hulufei"
|
||||||
|
+++
|
||||||
|
|
||||||
|
# Solar Theme for Zola
|
||||||
|
|
||||||
|
Port of [Solar theme for Hugo](https://github.com/bake/solar-theme-hugo) to Zola.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
First download this theme to your `themes` directory:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ cd themes
|
||||||
|
$ git clone https://github.com/hulufei/solar-theme-zola.git
|
||||||
|
```
|
||||||
|
and then enable it in your `config.toml`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
theme = "solar-theme-zola"
|
||||||
|
```
|
||||||
|
|
||||||
|
Add `title` and `description`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
title = "Your Blog Title"
|
||||||
|
description = "Your blog description"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Options
|
||||||
|
|
||||||
|
### Color schemes
|
||||||
|
|
||||||
|
Set color scheme to (Solarized) `dark` or (Solarized) `light` with `highlight_theme` option:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
highlight_theme = "solarized-dark"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Sidebar menu
|
||||||
|
|
||||||
|
Set a field in `extra` with a key of `site_menus`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
site_menus = [
|
||||||
|
{ url = "https://github/hulufei/solar-theme-zola", name = "Repository" },
|
||||||
|
{ url = "rss.xml", name = "RSS" },
|
||||||
|
]
|
||||||
|
```
|
||||||
|
Each link needs to have a `url` and a `name`.
|
||||||
|
|
||||||
|
|
||||||
63
docs/content/themes/toucan/index.md
Normal file
63
docs/content/themes/toucan/index.md
Normal file
|
|
@ -0,0 +1,63 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "Toucan"
|
||||||
|
description = "Inspired from Pelican default theme"
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://git.42l.fr/HugoTrentesaux/toucan.git"
|
||||||
|
homepage = "https://git.42l.fr/HugoTrentesaux/toucan"
|
||||||
|
minimum_version = "0.8.0"
|
||||||
|
license = "AGPL"
|
||||||
|
demo = "http://blog.coinduf.eu/"
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "Hugo Trentesaux"
|
||||||
|
homepage = "https://trentesaux.fr/"
|
||||||
|
+++
|
||||||
|
|
||||||
|
# Toucan
|
||||||
|
|
||||||
|
A light theme for Zola adapted from Pelican.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
You can add the theme as a submodule :
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git submodule add --name toucan https://git.42l.fr/HugoTrentesaux/toucan.git themes/toucan
|
||||||
|
```
|
||||||
|
|
||||||
|
and enable the theme in your `config.toml`
|
||||||
|
|
||||||
|
```toml
|
||||||
|
theme = "toucan"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Categories will be added to the menu, and all articles from categories with
|
||||||
|
|
||||||
|
```toml
|
||||||
|
transparent = true
|
||||||
|
```
|
||||||
|
|
||||||
|
will be listed in the home page.
|
||||||
|
|
||||||
|
You can personalize the following options :
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
title = "Toucan theme"
|
||||||
|
title_pic = "/favicon.ico"
|
||||||
|
description = "Theme for Zola inspired from Pelican website theme"
|
||||||
|
license = """Content under <a href="https://creativecommons.org/licenses/by-sa/4.0/">CC BY-SA</a> Licence"""
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
63
docs/content/themes/zerm/index.md
Normal file
63
docs/content/themes/zerm/index.md
Normal file
|
|
@ -0,0 +1,63 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "zerm"
|
||||||
|
description = "A minimalistic and dark theme based on Radek Kozieł's theme for Hugo"
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://github.com/ejmg/zerm.git"
|
||||||
|
homepage = "https://github.com/ejmg/zerm"
|
||||||
|
minimum_version = "0.8.0"
|
||||||
|
license = "MIT"
|
||||||
|
demo = "https://zerm.ejmg.now.sh/"
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "elias julian marko garcia"
|
||||||
|
homepage = "https://github.com/ejmg"
|
||||||
|
+++
|
||||||
|
|
||||||
|
# zerm
|
||||||
|
|
||||||
|
a minimalist and dark theme for [Zola](https://getzola.org).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
[**Live Preview!**](https://zerm.ejmg.now.sh/)
|
||||||
|
|
||||||
|
Largely a port of Radek Kozieł's [Terminal
|
||||||
|
Theme](https://github.com/panr/hugo-theme-terminal) for Hugo. 4/5ths of my way
|
||||||
|
through porting this theme, I discovered Paweł Romanowski own independent fork
|
||||||
|
for Zola, [Terminimal](https://github.com/pawroman/zola-theme-terminimal),
|
||||||
|
which helped me get the PostCSS to Sass styling conversion done more
|
||||||
|
quickly. My sincerest thanks to both of you!
|
||||||
|
|
||||||
|
## differences
|
||||||
|
|
||||||
|
This theme is largely true to the original by Radek, but there are some mild
|
||||||
|
differences. They are almost all stylistic in nature and are intended to
|
||||||
|
emphasize minimalism even more. Some of them are as follows:
|
||||||
|
- tags are now included in a post's meta data.
|
||||||
|
- no post image previews.
|
||||||
|
- categories are included in the taxonomy.
|
||||||
|
- bullet points have slightly more margin and different symbols for nesting.
|
||||||
|
- no social media or comment support.
|
||||||
|
|
||||||
|
Some of these might be added later and [PR's are always
|
||||||
|
welcomed](https://github.com/ejmg/zerm/pulls).
|
||||||
|
|
||||||
|
## configuration
|
||||||
|
|
||||||
|
Please follow the Zola documentation for [how to use a
|
||||||
|
theme](https://www.getzola.org/documentation/themes/installing-and-using-themes/#installing-a-theme).
|
||||||
|
|
||||||
|
In `config.toml`, you will find all values for customization that are supported
|
||||||
|
thus far have documentation explaining how they are used. If there is any confusion or something is not working as intended, [please open an issue](https://github.com/ejmg/zerm/issues)!
|
||||||
|
|
||||||
|
## license
|
||||||
|
|
||||||
|
MIT. See `LICENSE.md` for more details.
|
||||||
|
|
||||||
|
|
||||||
81
docs/content/themes/zola-henry/index.md
Normal file
81
docs/content/themes/zola-henry/index.md
Normal file
|
|
@ -0,0 +1,81 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "henry"
|
||||||
|
description = "A timeless blog theme"
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://github.com/sirodoht/zola-henry"
|
||||||
|
homepage = "https://github.com/sirodoht/zola-henry"
|
||||||
|
minimum_version = "0.4.0"
|
||||||
|
license = "MIT"
|
||||||
|
demo = ""
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "sirodoht"
|
||||||
|
homepage = ""
|
||||||
|
+++
|
||||||
|
|
||||||
|
# henry
|
||||||
|
|
||||||
|
Henry is a single-column [Zola](https://github.com/getzola/zola) theme based on the original Jekyll styles.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
First download this theme to your `themes` directory:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$ cd themes
|
||||||
|
$ git clone https://github.com/sirodoht/zola-henry.git henry
|
||||||
|
```
|
||||||
|
|
||||||
|
and then enable it in your `config.toml`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
theme = "henry"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Options
|
||||||
|
|
||||||
|
### Nav links
|
||||||
|
|
||||||
|
Set a field in `extra` with a key of `henry_links`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
henry_links = [
|
||||||
|
{url = "/about", name = "About"},
|
||||||
|
{url = "https://github.com/patrick", name = "Projects"},
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
Each link needs to have a `url` and a `name`.
|
||||||
|
|
||||||
|
### Footer GitHub icon link
|
||||||
|
|
||||||
|
By default Henry ships with GitHub icon link in the right side of the footer. You can change its link href in your `config.toml`.
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
henry_github = "https://github.com/sirodoht/zola-henry"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Footer Twitter icon link
|
||||||
|
|
||||||
|
Twitter is too mainstream and a bit lame, but 100% of our users have requested, so we offer it.
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
henry_twitter = "https://twitter.com/dhh"
|
||||||
|
```
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
MIT
|
||||||
|
|
||||||
|
|
||||||
51
docs/content/themes/zola-paper/index.md
Normal file
51
docs/content/themes/zola-paper/index.md
Normal file
|
|
@ -0,0 +1,51 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "zola-paper"
|
||||||
|
description = "A clean theme inspired from hugo-paper."
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://github.com/schoenenberg/zola-paper.git"
|
||||||
|
homepage = "https://github.com/schoenenberg/zola-paper"
|
||||||
|
minimum_version = "0.11.0"
|
||||||
|
license = "MIT"
|
||||||
|
demo = "https://schoenenberg.github.io/zola-paper"
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "Maximilian Schoenenberg"
|
||||||
|
homepage = "https://www.schoenenberg.dev"
|
||||||
|
+++
|
||||||
|
|
||||||
|
# Zola-Paper
|
||||||
|
A clean theme inspired from hugo-paper.
|
||||||
|
|
||||||
|
[Zola](https://getzola.org) port of [Hugo-Paper](https://github.com/nanxiaobei/hugo-paper/) (with a few tweaks).
|
||||||
|
|
||||||
|
**Demo:** [https://schoenenberg.github.com/zola-paper](https://schoenenberg.github.com/zola-paper)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
The easiest way to install this theme is to either clone it ...
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/schoenenberg/zola-paper.git themes/zola-paper
|
||||||
|
```
|
||||||
|
|
||||||
|
... or to use it as a submodule.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git submodule add https://github.com/schoenenberg/zola-paper.git themes/zola-paper
|
||||||
|
```
|
||||||
|
|
||||||
|
Either way, you will have to enable the theme in your `config.toml`.
|
||||||
|
|
||||||
|
```toml
|
||||||
|
theme = "zola-paper"
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
115
docs/content/themes/zola-pickles/index.md
Normal file
115
docs/content/themes/zola-pickles/index.md
Normal file
|
|
@ -0,0 +1,115 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "pickles"
|
||||||
|
description = "A modern, simple, clean blog theme for Zola."
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://github.com/lukehsiao/zola-pickles.git"
|
||||||
|
homepage = "https://github.com/lukehsiao/zola-pickles"
|
||||||
|
minimum_version = "0.11.0"
|
||||||
|
license = "MIT OR Apache-2.0"
|
||||||
|
demo = ""
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "Luke Hsiao"
|
||||||
|
homepage = "https://luke.hsiao.dev"
|
||||||
|
+++
|
||||||
|
|
||||||
|
# Pickles
|
||||||
|
Pickles is a clean, responsive blog theme based on the Hugo theme with the same name featuring pagination.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
First download this theme to your `themes` directory:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ cd themes
|
||||||
|
$ git clone https://github.com/lukehsiao/zola-pickles.git
|
||||||
|
```
|
||||||
|
and then enable it in your `config.toml`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
theme = "zola-pickles"
|
||||||
|
```
|
||||||
|
|
||||||
|
The theme requires putting the posts in the root of the `content` folder and to
|
||||||
|
enable pagination, for example in `content/_index.md`:
|
||||||
|
|
||||||
|
```
|
||||||
|
+++
|
||||||
|
paginate_by = 5
|
||||||
|
sort_by = "date"
|
||||||
|
insert_anchor_links = "right"
|
||||||
|
+++
|
||||||
|
```
|
||||||
|
|
||||||
|
## Reference guides
|
||||||
|
|
||||||
|
## Configuration Options
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
# A line to display underneath the main title
|
||||||
|
subtitle = "Example subtitle"
|
||||||
|
|
||||||
|
# Text to display in the footer of the page
|
||||||
|
copyright = "Copyright authors year"
|
||||||
|
|
||||||
|
# Your Google Analytics ID
|
||||||
|
analytics = ""
|
||||||
|
|
||||||
|
# See below
|
||||||
|
katex_enable = false
|
||||||
|
|
||||||
|
# See below
|
||||||
|
instantpage_enable = false
|
||||||
|
```
|
||||||
|
|
||||||
|
A full example configuration is included in config.toml.
|
||||||
|
|
||||||
|
Note how pickles also expects `title` and `description` to also be set in the
|
||||||
|
Zola configuration.
|
||||||
|
|
||||||
|
### KaTeX math formula support
|
||||||
|
|
||||||
|
This theme contains math formula support using [KaTeX](https://katex.org/),
|
||||||
|
which can be enabled by setting `katex_enable = true` in the `extra` section
|
||||||
|
of `config.toml`.
|
||||||
|
|
||||||
|
After enabling this extension, the `katex` short code can be used in documents:
|
||||||
|
* `{%/* katex(block=true) */%}\KaTeX{%/* end */%}` to typeset a block of math formulas,
|
||||||
|
similar to `$$...$$` in LaTeX
|
||||||
|
|
||||||
|
### Figure Shortcode
|
||||||
|
|
||||||
|
This them also includes a figure shortcode for convenience in captioning figures.
|
||||||
|
|
||||||
|
```
|
||||||
|
{%/* figure(link="https://www.example.com/", src="https://www.example.com/img.jpeg", alt="sample alt text") */%}
|
||||||
|
Your caption here.
|
||||||
|
{%/* end */%}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Fontawesome
|
||||||
|
|
||||||
|
This theme includes fontawesome, so that fontawesome icons can be directly used.
|
||||||
|
|
||||||
|
### Instant.page
|
||||||
|
|
||||||
|
The theme contains instant.page prefetching. This can be enabled by setting
|
||||||
|
`instantpage_enable = true` in the `extra` section of `config.toml`.
|
||||||
|
|
||||||
|
## Showing article summaries
|
||||||
|
|
||||||
|
By default, the theme will use the first 280 characters of your post as a
|
||||||
|
summary, if a proper [page
|
||||||
|
summary](https://www.getzola.org/documentation/content/page/#summary) using
|
||||||
|
`<!-- more -->` is not provided. For more sensible summaries, we recommend using
|
||||||
|
the manual more indicator.
|
||||||
|
|
||||||
|
|
||||||
64
docs/content/themes/zola-theme-hikari/index.md
Normal file
64
docs/content/themes/zola-theme-hikari/index.md
Normal file
|
|
@ -0,0 +1,64 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "Hikari"
|
||||||
|
description = "Fluid, responsive blog theme for Zola"
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://github.com/waynee95/zola-theme-hikari"
|
||||||
|
homepage = "https://github.com/waynee95/zola-theme-hikari"
|
||||||
|
minimum_version = "0.5.1"
|
||||||
|
license = "MIT"
|
||||||
|
demo = "https://waynee95.me/zola-theme-hikari"
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "waynee95"
|
||||||
|
homepage = "https://waynee95.me"
|
||||||
|
+++
|
||||||
|
|
||||||
|
# hikari
|
||||||
|
|
||||||
|
> this is a port of the [hikari theme](https://github.com/mx3m/hikari-for-jekyll) for [Zola](https://www.getzola.org/)
|
||||||
|
|
||||||
|
Hikari is a simple theme perfect for dev-savvy bloggers.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
[View demo](https://waynee95.github.io/zola-theme-hikari/)
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
First download the theme to your `themes` directory:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ cd themes
|
||||||
|
$ git clone https://github.com/waynee95/zola-theme-hikari
|
||||||
|
```
|
||||||
|
and then enable it in your `config.toml`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
theme = "hikari"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
author = "John Doge"
|
||||||
|
author_bio = "Lorem ipsum dolor sit amet, consectetur adipisicing elit. Ex, pariatur!"
|
||||||
|
twitter = "waynee955"
|
||||||
|
github = "waynee95"
|
||||||
|
instagram = false
|
||||||
|
enable_mathjax = false
|
||||||
|
```
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
[MIT](LICENSE)
|
||||||
|
|
||||||
|
Thanks to [Mathieu Mayer-Mazzoli](https://github.com/mx3m) for creating this awesome theme!
|
||||||
|
|
||||||
|
|
||||||
108
docs/content/themes/zola.386/index.md
Normal file
108
docs/content/themes/zola.386/index.md
Normal file
|
|
@ -0,0 +1,108 @@
|
||||||
|
|
||||||
|
+++
|
||||||
|
title = "zola.386"
|
||||||
|
description = "Zola port of the BOOTSTRA.386 theme."
|
||||||
|
template = "theme.html"
|
||||||
|
date = 2020-12-14T20:45:47+01:00
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
created = 2020-12-14T20:45:47+01:00
|
||||||
|
updated = 2020-12-14T20:45:47+01:00
|
||||||
|
repository = "https://github.com/lopes/zola.386"
|
||||||
|
homepage = "https://github.com/lopes/zola.386"
|
||||||
|
minimum_version = "0.10.1"
|
||||||
|
license = "MIT"
|
||||||
|
demo = "https://zola-386.netlify.com"
|
||||||
|
|
||||||
|
[extra.author]
|
||||||
|
name = "José Lopes"
|
||||||
|
homepage = "https://github.com/lopes"
|
||||||
|
+++
|
||||||
|
|
||||||
|
# ZOLA.386
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## [Live demo](https://zola386.netlify.app/)
|
||||||
|
|
||||||
|
ZOLA.386 is a port of the BOOTSTRA.386 theme and was based on:
|
||||||
|
|
||||||
|
- [BOOTSTRA.386](https://kristopolous.github.io/BOOTSTRA.386/): main idea, design.
|
||||||
|
- [HUGO.386](https://themes.gohugo.io/hugo.386/): item placement.
|
||||||
|
- [Dinkleberg](https://github.com/rust-br/dinkleberg): internal structure and SEO.
|
||||||
|
- [after-dark](https://github.com/getzola/after-dark): navbar and minor components.
|
||||||
|
|
||||||
|
ZOLA.386 is a theme that refers to the 90s, but with cutting edge features to be fast and responsive.
|
||||||
|
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
The easiest way to install ZOLA.386 is to clone this repository and build your site upon it:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ git clone https://github.com/lopes/zola.386
|
||||||
|
```
|
||||||
|
|
||||||
|
Of course you can install it just as another theme for your site, but ZOLA.386 must be added as a module:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ cd themes
|
||||||
|
$ git submodule add https://github.com/lopes/zola.386
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
Configuration is mainly done in `config.toml` and here I'll describe the main topics.
|
||||||
|
|
||||||
|
### Global
|
||||||
|
`config.toml` starts with the global variables. All of these items are important, but it is fundamental to create two taxonomies at least:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
taxonomies = [
|
||||||
|
{name="categories", rss=true},
|
||||||
|
{name="tags", rss=true},
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
Remember that all descriptions (`config.description` and `page.description`) are shown on the index page, one at the header and the others through the body.
|
||||||
|
|
||||||
|
### Extras
|
||||||
|
ZOLA.386 comes with a lot of extra variables which eases the creation and maintenance of the site, so it's important to review all of them after installing the theme.
|
||||||
|
|
||||||
|
The `zola386_menu` composes the navbar and is created by setting up a `path`, which will be appended to the `base_url` and the `name` will appear on the navbar.
|
||||||
|
|
||||||
|
```toml
|
||||||
|
zola386_menu = [
|
||||||
|
{path="/", name="Home"},
|
||||||
|
{path="categories", name="Categories"},
|
||||||
|
{path="tags", name="Tags"},
|
||||||
|
{path="about", name="About"},
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Social
|
||||||
|
ZOLA.386 is also prepared to deal with Google Analytics, Disqus, and Twitter --[Open Graph Protocol](https://ogp.me/) is welcome. This theme is prepared to use the output of [Favicon Generator](https://www.favicon-generator.org/), to do so, you'll just need to download the output of that site and extract in `static/images`.
|
||||||
|
|
||||||
|
As said, Disqus is supportted, but besides setting the username in `config.toml`, you also must to put a `comments = true` extra option on the pages where Disqus will be enabled --this gives you the freedom to enable or disable comments on certain posts. You can use the extra option `image` on each page, to represent that post.
|
||||||
|
|
||||||
|
### Animations
|
||||||
|
All JavaScript animations can be set at `static/js/zola386.js`. Basically you can disable all animations, use one or two scans, and change the scan speed. Personally, I prefer only one scan with a speed factor of 5.
|
||||||
|
|
||||||
|
### Language
|
||||||
|
Under the `label_` variables, you can set names to better localize your site. Note that you can change the language of a single page, by using `page.extra.lang`, which causes `<html lang="">` to change only on that page. A theme to provide information for its owner and SEO-friendly.
|
||||||
|
|
||||||
|
### Search
|
||||||
|
Search was implemented according to the [official documentation](https://www.getzola.org/documentation/content/search/). It uses JavaScript to search on an indexed version of the site based on `search_index.LANG.js`, `elasticlunr.min.js`, and `search.js` --the first two are generated after each build. If you're running your site in other default language other than English, you **must** change the `search_index.LANG.js` line in `index.html`, setting up `LANG` accordingly.
|
||||||
|
|
||||||
|
### Other files
|
||||||
|
The `content\_index.md` file must be properly configured to provide better experience. Check out this file for more information.
|
||||||
|
|
||||||
|
The 404 page is almost hardcoded, so you must edit it directly.
|
||||||
|
|
||||||
|
|
||||||
|
## License
|
||||||
|
This theme is released under the MIT license. For more information read the [License](https://github.com/lopes/zola.386/blob/master/LICENSE).
|
||||||
|
|
||||||
|
|
||||||
|
[](https://app.netlify.com/sites/zola386/deploys)
|
||||||
|
|
||||||
|
|
||||||
BIN
docs/content/themes/zola.386/screenshot.png
Normal file
BIN
docs/content/themes/zola.386/screenshot.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 84 KiB |
Loading…
Reference in a new issue