diff --git a/docs/content/themes/Ergo/index.md b/docs/content/themes/Ergo/index.md index 04a5d3c5..353210ba 100644 --- a/docs/content/themes/Ergo/index.md +++ b/docs/content/themes/Ergo/index.md @@ -3,23 +3,25 @@ title = "Ergo" description = "A simple blog Theme focused on writing, inspired by svbtle" template = "theme.html" -date = 2018-09-03T02:13:01-04:00 +date = 2020-07-08T12:08:02+02:00 [extra] -created = 2019-07-12T23:49:55+02:00 -updated = 2018-09-03T02:13:01-04:00 -repository = "https://github.com/InsidiousMind/Ergo" -homepage = "https://github.com/InsidiousMind/Ergo" +created = 2020-07-08T12:08:02+02:00 +updated = 2020-07-08T12:08:02+02: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://code.liquidthink.net" +homepage = "https://liquidthink.net" +++ -[ergo](http://ergo.liquidthink.net) +[ergo LIVE DEMO](http://ergo.liquidthink.net) + + ![Ergo Screenshot](https://i.imgur.com/l182IYg.jpg) @@ -59,6 +61,9 @@ Change them however you like! Feel free to go into theme and edit the colors. Ho # 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" + # website, should not be preceded with `http://` website = "code.liquidthink.net" @@ -70,6 +75,12 @@ twitter = "liquid_think" 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 diff --git a/docs/content/themes/Zulma/index.md b/docs/content/themes/Zulma/index.md index ffdbe6a5..15804958 100644 --- a/docs/content/themes/Zulma/index.md +++ b/docs/content/themes/Zulma/index.md @@ -3,11 +3,11 @@ title = "Zulma" description = "A zola theme based off bulma.css" template = "theme.html" -date = 2019-05-12T22:44:07+01:00 +date = 2020-07-08T12:08:02+02:00 [extra] -created = 2019-07-12T23:55:11+02:00 -updated = 2019-05-12T22:44:07+01:00 +created = 2020-07-08T12:08:02+02:00 +updated = 2020-07-08T12:08:02+02:00 repository = "https://github.com/Worble/Zulma" homepage = "https://github.com/Worble/Zulma" minimum_version = "0.6.0" @@ -56,7 +56,7 @@ git clone https://github.com/Worble/Zulma and then enable it in your `config.toml`: ```toml -theme = "zulma" +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. @@ -73,7 +73,7 @@ All the source javascript files live in `javascript/src`. Following is a list of ### 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 yourself (please ensure that you have [node, npm](https://nodejs.org/en/) and optionally [yarn](https://yarnpkg.com/lang/en/) installed): +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 @@ -81,6 +81,10 @@ 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 @@ -100,8 +104,8 @@ Zulma has 3 taxonomies already set internally: `tags`, `cateogories` and `author ```toml taxonomies = [ {name = "categories"}, - {name = "tags", paginate_by = 5, feed = true}, - {name = "authors", feed = true}, + {name = "tags", paginate_by = 5, rss = true}, + {name = "authors", rss = true}, ] ``` @@ -231,7 +235,7 @@ zulma_allow_theme_selection = true ## Original -This template is based on the [blog template](https://dansup.github.io/bulma-templates/templates/blog.html) over at [Free Bulma Templates](https://dansup.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. +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 diff --git a/docs/content/themes/after-dark/index.md b/docs/content/themes/after-dark/index.md index 52579550..60ad5522 100644 --- a/docs/content/themes/after-dark/index.md +++ b/docs/content/themes/after-dark/index.md @@ -3,14 +3,14 @@ title = "after-dark" description = "A robust, elegant dark theme" template = "theme.html" -date = 2017-11-07T17:39:37+01:00 +date = 2020-07-08T12:08:02+02:00 [extra] -created = 2019-04-06T11:27:43+02:00 -updated = 2017-11-07T17:39:37+01:00 -repository = "https://github.com/getzola/after-dark" +created = 2020-07-08T12:08:02+02:00 +updated = 2020-07-08T12:08:02+02:00 +repository = "https://github.com/getzola/after-dark.git" homepage = "https://github.com/getzola/after-dark" -minimum_version = "0.5.0" +minimum_version = "0.11.0" license = "MIT" demo = "https://zola-after-dark.netlify.com" @@ -55,9 +55,9 @@ The theme requires tags and categories taxonomies to be enabled in your `config. ```toml taxonomies = [ - # You can enable/disable feeds - {name = "categories", feed = true}, - {name = "tags", feed = true}, + # 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 diff --git a/docs/content/themes/anpu/index.md b/docs/content/themes/anpu/index.md new file mode 100644 index 00000000..11a41d85 --- /dev/null +++ b/docs/content/themes/anpu/index.md @@ -0,0 +1,79 @@ + ++++ +title = "Anpu" +description = "A port of the Hugo Anubis theme" +template = "theme.html" +date = 2020-07-08T12:08:02+02:00 + +[extra] +created = 2020-07-08T12:08:02+02:00 +updated = 2020-07-08T12:08:02+02: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). + +![screenshot](screenshot.png) + +## 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). + \ No newline at end of file diff --git a/docs/content/themes/anpu/screenshot.png b/docs/content/themes/anpu/screenshot.png new file mode 100644 index 00000000..9d472012 Binary files /dev/null and b/docs/content/themes/anpu/screenshot.png differ diff --git a/docs/content/themes/book/index.md b/docs/content/themes/book/index.md index 04f94bfe..d76a8da3 100644 --- a/docs/content/themes/book/index.md +++ b/docs/content/themes/book/index.md @@ -3,12 +3,12 @@ title = "book" description = "A book theme inspired from GitBook/mdBook" template = "theme.html" -date = 2018-01-28T10:53:19+01:00 +date = 2020-07-08T12:08:02+02:00 [extra] -created = 2018-11-17T18:27:11+01:00 -updated = 2018-01-28T10:53:19+01:00 -repository = "https://github.com/getzola/book" +created = 2020-07-08T12:08:02+02:00 +updated = 2020-07-08T12:08:02+02:00 +repository = "https://github.com/getzola/book.git" homepage = "https://github.com/getzola/book" minimum_version = "0.5.0" license = "MIT" diff --git a/docs/content/themes/clean-blog/index.md b/docs/content/themes/clean-blog/index.md index 773a9b37..5babbbde 100644 --- a/docs/content/themes/clean-blog/index.md +++ b/docs/content/themes/clean-blog/index.md @@ -3,11 +3,11 @@ title = "Clean Blog" description = "A port of Start Bootstrap Clean Blog for Zola" template = "theme.html" -date = 2020-01-01T23:06:35+00:00 +date = 2020-07-08T12:08:02+02:00 [extra] -created = 2020-01-01T23:06:35+00:00 -updated = 2020-01-01T23:06:35+00:00 +created = 2020-07-08T12:08:02+02:00 +updated = 2020-07-08T12:08:02+02:00 repository = "https://github.com/dave-tucker/zola-clean-blog" homepage = "https://github.com/dave-tucker/zola-clean-blog" minimum_version = "0.4.0" diff --git a/docs/content/themes/dinkleberg/index.md b/docs/content/themes/dinkleberg/index.md index 4f9d0e7e..3054abe0 100644 --- a/docs/content/themes/dinkleberg/index.md +++ b/docs/content/themes/dinkleberg/index.md @@ -3,11 +3,11 @@ title = "dinkleberg" description = "The Rust BR theme for Gutenberg" template = "theme.html" -date = 2018-05-31T23:02:50-03:00 +date = 2020-07-08T12:08:02+02:00 [extra] -created = 2019-04-06T11:27:43+02:00 -updated = 2018-05-31T23:02:50-03:00 +created = 2020-07-08T12:08:02+02:00 +updated = 2020-07-08T12:08:02+02:00 repository = "https://github.com/rust-br/dinkleberg.git" homepage = "https://github.com/rust-br/dinkleberg" minimum_version = "0.4.0" @@ -46,6 +46,7 @@ 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 diff --git a/docs/content/themes/docsascode-theme/index.md b/docs/content/themes/docsascode-theme/index.md index 98e1ad2e..43810905 100644 --- a/docs/content/themes/docsascode-theme/index.md +++ b/docs/content/themes/docsascode-theme/index.md @@ -3,16 +3,16 @@ title = "Docsascode_theme" description = "A modern simple Zola's theme related to docs as code methodology" template = "theme.html" -date = 2020-03-05T23:16:20+03:00 +date = 2020-07-08T12:08:02+02:00 [extra] -created = 2020-03-05T23:16:20+03:00 -updated = 2020-03-05T23:16:20+03:00 +created = 2020-07-08T12:08:02+02:00 +updated = 2020-07-08T12:08:02+02: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 = "docsascode.codeandmedia.com" +demo = "https://docsascode.codeandmedia.com" [extra.author] name = "Roman Soldatenkov" @@ -23,10 +23,10 @@ homepage = "https://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 push to your Docker an [image with demo-content](https://hub.docker.com/r/codeandmedia/zola_docsascode_theme) +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/zola_docsascode_theme:latest +codeandmedia/docsascode-theme:latest ``` ## Perks diff --git a/docs/content/themes/even/index.md b/docs/content/themes/even/index.md index f9beedcb..dc78c4e8 100644 --- a/docs/content/themes/even/index.md +++ b/docs/content/themes/even/index.md @@ -3,14 +3,14 @@ title = "even" description = "A robust, elegant dark theme" template = "theme.html" -date = 2018-01-25T18:44:44+01:00 +date = 2020-07-08T12:08:02+02:00 [extra] -created = 2019-07-12T23:49:55+02:00 -updated = 2018-01-25T18:44:44+01:00 -repository = "https://github.com/getzola/even" +created = 2020-07-08T12:08:02+02:00 +updated = 2020-07-08T12:08:02+02:00 +repository = "https://github.com/getzola/even.git" homepage = "https://github.com/getzola/even" -minimum_version = "0.6.0" +minimum_version = "0.11.0" license = "MIT" demo = "https://zola-even.netlify.com" @@ -48,9 +48,9 @@ The theme requires tags and categories taxonomies to be enabled in your `config. ```toml taxonomies = [ - # You can enable/disable feeds - {name = "categories", feed = true}, - {name = "tags", feed = true}, + # 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 diff --git a/docs/content/themes/feather/index.md b/docs/content/themes/feather/index.md index ad3a9458..e605016f 100644 --- a/docs/content/themes/feather/index.md +++ b/docs/content/themes/feather/index.md @@ -3,11 +3,11 @@ title = "feather" description = "A modern blog theme" template = "theme.html" -date = 2018-01-21T04:35:36-05:00 +date = 2020-07-08T12:08:02+02:00 [extra] -created = 2019-07-12T23:49:55+02:00 -updated = 2018-01-21T04:35:36-05:00 +created = 2020-07-08T12:08:02+02:00 +updated = 2020-07-08T12:08:02+02:00 repository = "https://github.com/piedoom/feather" homepage = "https://github.com/piedoom/feather" minimum_version = "0.5.1" diff --git a/docs/content/themes/float/index.md b/docs/content/themes/float/index.md new file mode 100644 index 00000000..dad28b13 --- /dev/null +++ b/docs/content/themes/float/index.md @@ -0,0 +1,145 @@ + ++++ +title = "Float" +description = "An elegant blog theme" +template = "theme.html" +date = 2020-07-08T12:08:02+02:00 + +[extra] +created = 2020-07-08T12:08:02+02:00 +updated = 2020-07-08T12:08:02+02: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/" ++++ + +![Float](content/blog/2020-06-14-Float theme for Zola/Float.png) + +**[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 = "" + +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 的分頁設定。 + + \ No newline at end of file diff --git a/docs/content/themes/float/screenshot.png b/docs/content/themes/float/screenshot.png new file mode 100644 index 00000000..c4e7c1e3 Binary files /dev/null and b/docs/content/themes/float/screenshot.png differ diff --git a/docs/content/themes/hallo/index.md b/docs/content/themes/hallo/index.md index 83caee49..5fd8bc48 100644 --- a/docs/content/themes/hallo/index.md +++ b/docs/content/themes/hallo/index.md @@ -3,11 +3,11 @@ title = "hallo" description = "A single-page theme to introduce yourself." template = "theme.html" -date = 2019-06-05T15:08:48+02:00 +date = 2020-07-08T12:08:02+02:00 [extra] -created = 2019-07-12T23:55:11+02:00 -updated = 2019-06-05T15:08:48+02:00 +created = 2020-07-08T12:08:02+02:00 +updated = 2020-07-08T12:08:02+02:00 repository = "https://github.com/flyingP0tat0/zola-hallo.git" homepage = "https://github.com/janbaudisch/zola-hallo" minimum_version = "0.4.0" diff --git a/docs/content/themes/hyde/index.md b/docs/content/themes/hyde/index.md index 7743975c..9fba0b41 100644 --- a/docs/content/themes/hyde/index.md +++ b/docs/content/themes/hyde/index.md @@ -3,14 +3,14 @@ title = "hyde" description = "A classic blog theme" template = "theme.html" -date = 2017-10-24T15:01:52+02:00 +date = 2020-07-08T12:08:02+02:00 [extra] -created = 2019-04-06T11:27:43+02:00 -updated = 2017-10-24T15:01:52+02:00 -repository = "https://github.com/getzola/hyde" +created = 2020-07-08T12:08:02+02:00 +updated = 2020-07-08T12:08:02+02:00 +repository = "https://github.com/getzola/hyde.git" homepage = "https://github.com/getzola/hyde" -minimum_version = "0.5.0" +minimum_version = "0.11.0" license = "MIT" demo = "https://zola-hyde.netlify.com" diff --git a/docs/content/themes/sam/index.md b/docs/content/themes/sam/index.md index 300bfd85..4b5b0e12 100644 --- a/docs/content/themes/sam/index.md +++ b/docs/content/themes/sam/index.md @@ -3,11 +3,11 @@ title = "sam" description = "A Simple and Minimalist theme with a focus on typography and content." template = "theme.html" -date = 2019-07-02T17:55:24+02:00 +date = 2020-07-08T12:08:02+02:00 [extra] -created = 2019-07-02T17:55:24+02:00 -updated = 2019-07-02T17:55:24+02:00 +created = 2020-07-08T12:08:02+02:00 +updated = 2020-07-08T12:08:02+02:00 repository = "https://github.com/janbaudisch/zola-sam.git" homepage = "https://github.com/janbaudisch/zola-sam" minimum_version = "0.4.0" diff --git a/docs/content/themes/simple-dev-blog/index.md b/docs/content/themes/simple-dev-blog/index.md new file mode 100644 index 00000000..551ef748 --- /dev/null +++ b/docs/content/themes/simple-dev-blog/index.md @@ -0,0 +1,62 @@ + ++++ +title = "simple-dev-blog" +description = "A simple dev blog theme with no javascript, prerendered linked pages and SEO tags." +template = "theme.html" +date = 2020-07-08T12:08:02+02:00 + +[extra] +created = 2020-07-08T12:08:02+02:00 +updated = 2020-07-08T12:08:02+02: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/" ++++ + + +![preview image](https://i.imgur.com/IWoJtkF.png) + +# 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. 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! + + + \ No newline at end of file diff --git a/docs/content/themes/simple-dev-blog/screenshot.png b/docs/content/themes/simple-dev-blog/screenshot.png new file mode 100644 index 00000000..c5ecdfab Binary files /dev/null and b/docs/content/themes/simple-dev-blog/screenshot.png differ diff --git a/docs/content/themes/slim/index.md b/docs/content/themes/slim/index.md index 5eb8167d..92dc143f 100644 --- a/docs/content/themes/slim/index.md +++ b/docs/content/themes/slim/index.md @@ -3,11 +3,11 @@ title = "Slim" description = "Slim is a minimal, clean and beautiful theme for Zola." template = "theme.html" -date = 2019-10-01T01:16:57+01:00 +date = 2020-07-08T12:08:02+02:00 [extra] -created = 2019-10-01T01:16:57+01:00 -updated = 2019-10-01T01:16:57+01:00 +created = 2020-07-08T12:08:02+02:00 +updated = 2020-07-08T12:08:02+02:00 repository = "https://github.com/jameshclrk/zola-slim" homepage = "https://github.com/jameshclrk/zola-slim" minimum_version = "0.8.0" diff --git a/docs/content/themes/solar-theme-zola/index.md b/docs/content/themes/solar-theme-zola/index.md new file mode 100644 index 00000000..aaf3a6ff --- /dev/null +++ b/docs/content/themes/solar-theme-zola/index.md @@ -0,0 +1,71 @@ + ++++ +title = "solar-theme-zola" +description = "A port of solar-theme-hugo for zola" +template = "theme.html" +date = 2020-07-08T12:08:02+02:00 + +[extra] +created = 2020-07-08T12:08:02+02:00 +updated = 2020-07-08T12:08:02+02: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. + +![screenshot](./screenshot.png) + +## 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`. + + \ No newline at end of file diff --git a/docs/content/themes/solar-theme-zola/screenshot.png b/docs/content/themes/solar-theme-zola/screenshot.png new file mode 100644 index 00000000..05186b54 Binary files /dev/null and b/docs/content/themes/solar-theme-zola/screenshot.png differ diff --git a/docs/content/themes/zola-henry/index.md b/docs/content/themes/zola-henry/index.md new file mode 100644 index 00000000..d688aef0 --- /dev/null +++ b/docs/content/themes/zola-henry/index.md @@ -0,0 +1,72 @@ + ++++ +title = "henry" +description = "A timeless blog theme" +template = "theme.html" +date = 2020-07-08T12:08:02+02:00 + +[extra] +created = 2020-07-08T12:08:02+02:00 +updated = 2020-07-08T12:08:02+02: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. + +![Henry screenshot](screenshot.png) + +## 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" +``` + +## License + +MIT + + \ No newline at end of file diff --git a/docs/content/themes/zola-henry/screenshot.png b/docs/content/themes/zola-henry/screenshot.png new file mode 100644 index 00000000..f12cfa58 Binary files /dev/null and b/docs/content/themes/zola-henry/screenshot.png differ diff --git a/docs/content/themes/zola-paper/index.md b/docs/content/themes/zola-paper/index.md new file mode 100644 index 00000000..097ef4d7 --- /dev/null +++ b/docs/content/themes/zola-paper/index.md @@ -0,0 +1,51 @@ + ++++ +title = "zola-paper" +description = "A clean theme inspired from hugo-paper." +template = "theme.html" +date = 2020-07-08T12:08:02+02:00 + +[extra] +created = 2020-07-08T12:08:02+02:00 +updated = 2020-07-08T12:08:02+02: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) + +![Screenshot](screenshot.png) + +## 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" +``` + + \ No newline at end of file diff --git a/docs/content/themes/zola-paper/screenshot.png b/docs/content/themes/zola-paper/screenshot.png new file mode 100644 index 00000000..91973a42 Binary files /dev/null and b/docs/content/themes/zola-paper/screenshot.png differ diff --git a/docs/content/themes/zola-pickles/index.md b/docs/content/themes/zola-pickles/index.md index 4935a0b9..5a33f677 100644 --- a/docs/content/themes/zola-pickles/index.md +++ b/docs/content/themes/zola-pickles/index.md @@ -3,14 +3,14 @@ title = "pickles" description = "A modern, simple, clean blog theme for Zola." template = "theme.html" -date = 2020-02-06T18:26:26-08:00 +date = 2020-07-08T12:08:02+02:00 [extra] -created = 2020-02-06T18:26:26-08:00 -updated = 2020-02-06T18:26:26-08:00 +created = 2020-07-08T12:08:02+02:00 +updated = 2020-07-08T12:08:02+02:00 repository = "https://github.com/lukehsiao/zola-pickles.git" homepage = "https://github.com/lukehsiao/zola-pickles" -minimum_version = "0.4.0" +minimum_version = "0.11.0" license = "MIT OR Apache-2.0" demo = "" @@ -48,7 +48,9 @@ insert_anchor_links = "right" +++ ``` -## Options +## Reference guides + +## Configuration Options ```toml [extra] @@ -63,8 +65,16 @@ 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/), @@ -83,11 +93,23 @@ 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 +`` is not provided. For more sensible summaries, we recommend using +the manual more indicator. + \ No newline at end of file diff --git a/docs/content/themes/zola-theme-hikari/index.md b/docs/content/themes/zola-theme-hikari/index.md index c4ab31fe..828a0ff9 100644 --- a/docs/content/themes/zola-theme-hikari/index.md +++ b/docs/content/themes/zola-theme-hikari/index.md @@ -3,11 +3,11 @@ title = "Hikari" description = "Fluid, responsive blog theme for Zola" template = "theme.html" -date = 2019-01-27T19:57:59+01:00 +date = 2020-07-08T12:08:02+02:00 [extra] -created = 2019-07-12T23:49:55+02:00 -updated = 2019-01-27T19:57:59+01:00 +created = 2020-07-08T12:08:02+02:00 +updated = 2020-07-08T12:08:02+02:00 repository = "https://github.com/waynee95/zola-theme-hikari" homepage = "https://github.com/waynee95/zola-theme-hikari" minimum_version = "0.5.1" @@ -59,6 +59,6 @@ enable_mathjax = false [MIT](LICENSE) -Thanks to [Mathieu Mayer-Mazzoli](//github.com/mx3m) for creating this awesome theme! +Thanks to [Mathieu Mayer-Mazzoli](https://github.com/mx3m) for creating this awesome theme! \ No newline at end of file diff --git a/docs/content/themes/zola.386/index.md b/docs/content/themes/zola.386/index.md new file mode 100644 index 00000000..279a7e22 --- /dev/null +++ b/docs/content/themes/zola.386/index.md @@ -0,0 +1,107 @@ + ++++ +title = "zola.386" +description = "Zola port of the BOOTSTRA.386 theme." +template = "theme.html" +date = 2020-07-08T12:08:02+02:00 + +[extra] +created = 2020-07-08T12:08:02+02:00 +updated = 2020-07-08T12:08:02+02:00 +repository = "https://github.com/lopes/zola.386" +homepage = "https://github.com/lopes/zola.386" +minimum_version = "0.1.3" +license = "MIT" +demo = "https://zola-386.netlify.com" + +[extra.author] +name = "José Lopes" +homepage = "https://github.com/lopes" ++++ + +# ZOLA.386 + +![ZOLA.386 screenshot](https://github.com/lopes/zola.386/blob/master/screenshot.png?raw=true) + +## [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. + + +## Instalation +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 clone https://github.com/lopes/zola.386.git +``` + + +## 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 `disqus = true` extra option on the pages where Disqus will be enable --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 `` to change only on that page. A theme to provide information for its owner and SEO-friendly. + +### 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). + + +[![Netlify Status](https://api.netlify.com/api/v1/badges/5d6f1986-7bf3-40d3-b298-3339288585d4/deploy-status)](https://app.netlify.com/sites/zola386/deploys) + + \ No newline at end of file diff --git a/docs/content/themes/zola.386/screenshot.png b/docs/content/themes/zola.386/screenshot.png new file mode 100644 index 00000000..ca4f7149 Binary files /dev/null and b/docs/content/themes/zola.386/screenshot.png differ