diff --git a/docs/content/themes/DeepThought/index.md b/docs/content/themes/DeepThought/index.md index 58684f6ab6..d78cad1f1a 100644 --- a/docs/content/themes/DeepThought/index.md +++ b/docs/content/themes/DeepThought/index.md @@ -3,11 +3,11 @@ title = "DeepThought" description = "A simple blog theme focused on writing powered by Bulma and Zola." template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/RatanShreshtha/DeepThought.git" homepage = "https://github.com/RatanShreshtha/DeepThought" minimum_version = "0.9.0" diff --git a/docs/content/themes/Ergo/index.md b/docs/content/themes/Ergo/index.md index 46dfb44e1e..891f10818f 100644 --- a/docs/content/themes/Ergo/index.md +++ b/docs/content/themes/Ergo/index.md @@ -3,11 +3,11 @@ title = "Ergo" description = "A simple blog Theme focused on writing, inspired by svbtle" template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/InsidiousMind/Ergo.git" homepage = "https://github.com/insipx/Ergo" minimum_version = "0.4.1" diff --git a/docs/content/themes/Zulma/index.md b/docs/content/themes/Zulma/index.md index 4f788c7637..321d8080fc 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 = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/Worble/Zulma" homepage = "https://github.com/Worble/Zulma" minimum_version = "0.6.0" diff --git a/docs/content/themes/adidoks/index.md b/docs/content/themes/adidoks/index.md index afb5401a81..130bfb66c6 100644 --- a/docs/content/themes/adidoks/index.md +++ b/docs/content/themes/adidoks/index.md @@ -3,11 +3,11 @@ title = "adidoks" description = "AdiDoks is a Zola theme helping you build modern documentation." template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/aaranxu/adidoks.git" homepage = "https://github.com/aaranxu/adidoks" minimum_version = "0.13.0" @@ -21,7 +21,7 @@ homepage = "https://github.com/aaranxu" # Zola Theme AdiDoks -AdiDoks is a mordern documentation theme, which is a port of the Hugo +AdiDoks is a modern documentation theme, which is a port of the Hugo theme [Doks](https://github.com/h-enk/doks) for Zola. ## Demo @@ -73,7 +73,7 @@ git submodule add https://github.com/aaranxu/adidoks.git themes/adidoks ### Step 3: Configuration -Enable the theme in your `config.toml` in the site derectory: +Enable the theme in your `config.toml` in the site directory: ```toml theme = "adidoks" diff --git a/docs/content/themes/after-dark/index.md b/docs/content/themes/after-dark/index.md index b05d05b1a5..857add3c22 100644 --- a/docs/content/themes/after-dark/index.md +++ b/docs/content/themes/after-dark/index.md @@ -3,11 +3,11 @@ title = "after-dark" description = "A robust, elegant dark theme" template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/getzola/after-dark.git" homepage = "https://github.com/getzola/after-dark" minimum_version = "0.11.0" @@ -29,6 +29,7 @@ homepage = "https://www.vincentprouillet.com" - [Options](#options) - [Top menu](#top-menu) - [Title](#title) + - [Author](#author) ## Installation First download this theme to your `themes` directory: @@ -86,6 +87,23 @@ The site title is shown on the homepage. As it might be different from the ` ... {%/* endblock analytics */%} ``` + \ No newline at end of file diff --git a/docs/content/themes/codinfox-zola/index.md b/docs/content/themes/codinfox-zola/index.md index a29a744b10..7de7118e72 100644 --- a/docs/content/themes/codinfox-zola/index.md +++ b/docs/content/themes/codinfox-zola/index.md @@ -3,11 +3,11 @@ title = "codinfox-zola" description = "Codinfox theme for Zola" template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/svavs/codinfox-zola" homepage = "https://github.com/svavs/codinfox-zola" minimum_version = "0.11.0" diff --git a/docs/content/themes/dinkleberg/index.md b/docs/content/themes/dinkleberg/index.md index bc84d138e8..aca99e8d94 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 = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/rust-br/dinkleberg.git" homepage = "https://github.com/rust-br/dinkleberg" minimum_version = "0.4.0" diff --git a/docs/content/themes/docsascode-theme/index.md b/docs/content/themes/docsascode-theme/index.md index 1b822d1b17..9f32984cd0 100644 --- a/docs/content/themes/docsascode-theme/index.md +++ b/docs/content/themes/docsascode-theme/index.md @@ -3,11 +3,11 @@ title = "Docsascode_theme" description = "A modern simple Zola's theme related to docs as code methodology" template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/codeandmedia/zola_docsascode_theme.git" homepage = "https://github.com/codeandmedia/zola_docsascode_theme" minimum_version = "0.10.0" diff --git a/docs/content/themes/dose/index.md b/docs/content/themes/dose/index.md index 4dfbbdaeb2..3ac3e0b61e 100644 --- a/docs/content/themes/dose/index.md +++ b/docs/content/themes/dose/index.md @@ -3,20 +3,20 @@ title = "dose" description = "a small blog theme" template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/oltdaniel/dose.git" -homepage = "https://github.com/oltd/dose" -minimum_version = "0.13.0" +homepage = "https://github.com/oltdaniel/dose" +minimum_version = "0.14.0" license = "MIT" -demo = "https://oltd.github.io/dose" +demo = "https://oltdaniel.github.io/dose" [extra.author] -name = "oltd" -homepage = "https://oltd.dev" +name = "oltdaniel" +homepage = "https://oltdaniel.eu" +++ # dose @@ -29,7 +29,7 @@ First download this theme to your `themes` directory: ```bash cd themes -git clone https://github.com/oltd/dose.git +git clone https://github.com/oltdaniel/dose.git ``` and then enable it in your `config.toml`: @@ -51,8 +51,8 @@ And the theme uses the following extras: ```toml [extra] social_media = [ - {name = "GitHub", url = "https://github.com/oltd"}, - {name = "Twitter", url = "https://twitter.com/@oltd_maker"}, + {name = "GitHub", url = "https://github.com/oltdaniel"}, + {name = "Twitter", url = "https://twitter.com/@twitter"}, ] ``` @@ -90,19 +90,38 @@ This theme supports dark and light mode. Currently this will be only switched ba #### Size -We need about `2kB` extra stuff aside from images and raw html. This is divided up to `1.7kB CSS` and `~300B JS`. +We need about `~2.3KiB` extra stuff aside from images and raw html. This is divided up to `~2.1KiB CSS` and `212B JS`. + +Test yourself with `zola build 1>/dev/null; echo "scale=2; $(cat public/**/*.{js,css} | wc -c)/1024" | bc -l`. #### Syntax Highlighting As I didn't want to invest any time in creating an own syntax color schema for this theme, I suggest to use `visual-studio-dark`, which is the same one used in the demo page. +#### Customization + +You can create your own version of this theme, by simply changing the sass variables in `sass/style.scss` to match your taste. + +```scss +/** + * Variables + */ +$base-background: white; +$text-color: black; +$article-tag: green; +$lang-tag: red; +$link-color: blue; +$target-color: yellow; +$separator-decoration: "//////"; +``` + ### TODO -- [ ] introduce sass variables for colors -- [ ] dark/light switch with javascript and store in browser session +- [x] introduce sass variables for colors +- [x] dark/light switch with javascript and store in browser local storage ## License -![GitHub](https://img.shields.io/github/license/oltd/dose) +![GitHub](https://img.shields.io/github/license/oltdaniel/dose) \ No newline at end of file diff --git a/docs/content/themes/dose/screenshot.png b/docs/content/themes/dose/screenshot.png index 6eb257c4df..6b21cd7e90 100644 Binary files a/docs/content/themes/dose/screenshot.png and b/docs/content/themes/dose/screenshot.png differ diff --git a/docs/content/themes/even/index.md b/docs/content/themes/even/index.md index 46cb9c5bfe..7032442116 100644 --- a/docs/content/themes/even/index.md +++ b/docs/content/themes/even/index.md @@ -3,11 +3,11 @@ title = "even" description = "A robust, elegant dark theme" template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/getzola/even.git" homepage = "https://github.com/getzola/even" minimum_version = "0.11.0" diff --git a/docs/content/themes/feather/index.md b/docs/content/themes/feather/index.md index 1081bf5ac1..11c3049ee1 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 = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01: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 index 5c58a0709e..c5ae5c8db7 100644 --- a/docs/content/themes/float/index.md +++ b/docs/content/themes/float/index.md @@ -3,11 +3,11 @@ title = "Float" description = "An elegant blog theme" template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://gitlab.com/float-theme/float.git" homepage = "https://float-theme.netlify.app/" minimum_version = "0.11.0" @@ -47,7 +47,7 @@ Float 是一款為 [Zola](https://www.getzola.org/) 設計的佈景主題。 把 Float 以 Git 子模組的方式加入專案內： ```shell -git submodule add https://gitlab.com/float-theme/float.git theme/float +git submodule add https://gitlab.com/float-theme/float.git themes/float ``` 編輯您的 config.toml，指定 Float 作為佈景主題： diff --git a/docs/content/themes/hallo/index.md b/docs/content/themes/hallo/index.md index 630bfd36fc..443f18b687 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 = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/flyingP0tat0/zola-hallo.git" homepage = "https://github.com/janbaudisch/zola-hallo" minimum_version = "0.4.0" @@ -56,10 +56,7 @@ 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. - +The introduction text is made in `content/_index.md`. ## Options diff --git a/docs/content/themes/hook/index.md b/docs/content/themes/hook/index.md index 9466dfc567..da604cd9ba 100644 --- a/docs/content/themes/hook/index.md +++ b/docs/content/themes/hook/index.md @@ -3,11 +3,11 @@ title = "Hook" description = "Clean and simple personal site/blog theme" template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/InputUsername/zola-hook.git" homepage = "https://github.com/InputUsername/zola-hook" minimum_version = "0.15.2" diff --git a/docs/content/themes/hyde/index.md b/docs/content/themes/hyde/index.md index 7ca015fe91..9f50c3194a 100644 --- a/docs/content/themes/hyde/index.md +++ b/docs/content/themes/hyde/index.md @@ -3,11 +3,11 @@ title = "hyde" description = "A classic blog theme" template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/getzola/hyde.git" homepage = "https://github.com/getzola/hyde" minimum_version = "0.11.0" diff --git a/docs/content/themes/juice/index.md b/docs/content/themes/juice/index.md index 1d4d598b7a..c68ecd8aa3 100644 --- a/docs/content/themes/juice/index.md +++ b/docs/content/themes/juice/index.md @@ -3,11 +3,11 @@ title = "juice" description = "An intuitive, elegant, and lightweight Zola theme for product sites." template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/huhu/juice" homepage = "https://github.com/huhu/juice" minimum_version = "0.11.0" @@ -106,6 +106,15 @@ You can override theme variable by creating a file named `_variables.html` in yo ``` +### Favicon + +```html +{%/* extends "juice/templates/index.html" */%} +{%/* block favicon */%} + +{%/* endblock favicon */%} +``` + # Configuration You can customize some builtin property in `config.toml` file: diff --git a/docs/content/themes/karzok/index.md b/docs/content/themes/karzok/index.md index 4a0d1ee925..76f8c1679c 100644 --- a/docs/content/themes/karzok/index.md +++ b/docs/content/themes/karzok/index.md @@ -3,13 +3,13 @@ title = "karzok" description = "A theme for your documentation. Fast and secure" template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/kogeletey/karzok" -homepage = "https://fmatch.org/karzok" +homepage = "https://github.com/kogeletey/karzok" minimum_version = "0.0.14" license = "Apache-2.0" demo = "https://fmatch.org/karzok" @@ -19,12 +19,19 @@ name = "Konrad Geletey" homepage = "" +++ -[![builds.sr.ht status](https://builds.sr.ht/~kogeletey/karzok.svg)](https://builds.sr.ht/~kogeletey/karzok?) +

+ builds.sr.ht status + designed with penpot +

+ # Karzok + A theme for your documentation. Fast and secure ![screenshot](./screenshot.png) + ## Demo + [Fmatch Karzok](https://fmatch.org/karzok) ## Requirements @@ -41,11 +48,11 @@ for your platform. ### Optional 1. [yj](https://github.com/sclevine/yj) - > for transfer toml file in yaml + > for transfer toml file in yaml 2. [docker](https://docs.docker.com/engine/install/) - > for packaging container + > for packaging container 3. [rsync](https://rsync.samba.org/) - > A better copy and move + > A better copy and move ## Get Started @@ -82,21 +89,14 @@ See more in [Karzok Configuration](#configuration) ```zsh cp ./themes/content/_index.md content/_index.md - cp ./thems/content/tmpl.md content/filename.md + # a template will appear with which you can quickly start writing + # cp ./themes/content/tmpl.md content/filename.md ``` how you can give freedom to your creativity ### 5. Run the project -#### With [docker-compose](https://docs.docker.com/compose) and [cargo make](https://sagiegurari.github.io/cargo-make/) - -```zsh -cargo make --makefile make.toml dockerup -``` - -#### Without - i. development enviroment 1. Install node dependencies needed to work @@ -116,7 +116,7 @@ changes live reolad. ii. production enviroment -- with docker +- with docker 1. Build docker image @@ -150,10 +150,15 @@ Open in favorite browser [https://localhost](http://localhost) 1. `math` - rendering math formulas throught [katex](https://katex.org) 2. `favicon` - set path to favicon icon import(default `favicon`) -3. `localcdn`- if you want to store all assets on your domain, then enable this setting -4. `cdnurl` - you can customize your url to store assets,default use [jsdelivr](https://www.jsdelivr.com) -5. `[[extra.menu]]` - the main navigation on the site -6. `[[extra.header]]` - the header navigantion for the site +3. `localcdn`- if you want to store all assets on your domain, then enable this + setting +4. `cdnurl` - you can customize your url to store assets,default use + [jsdelivr](https://www.jsdelivr.com) +5. `show_word_count` - allowing you to show number of words +6. `show_reading_time`- allowing you to show reading time +7. `children`- for header nesting to work +8. `[[extra.menu]]` - the main navigation on the site +9. `[[extra.header]]` - the header navigantion for the site ### Templates @@ -164,26 +169,21 @@ All pages are extend to the base.html, and you can customize them as need. This program is Free Software: You can use, study share and improve it at your will. Specifically you can redistribute and/or modify it under the terms of the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) + # Contribute + Make sure to read the [Code of Conduct](/meta/code-of-conduct) ## Find bugs and come up with features -On the [todo.sr.ht](https://todo.sr.ht/~kogeletey/karzok) or [github issues](https://github.com/kogeletey/karzok/issues) + +On the [todo.sr.ht](https://todo.sr.ht/~kogeletey/karzok) or +[github issues](https://github.com/kogeletey/karzok/issues) ## Improve Code -The Karzok is stored in the repository at [sr.ht](https://sr.ht/~kogeletey/karzok) and mirror [github](https://github.com/kogeletey/karzok) -### TODOs: -- [ ] readme contrubutions -- [x] configure loading from cdn -- [x] choose code_of_conduct -- [x] proceed subpages -- [ ] create mobile version -- [x] choose license -- [ ] adding full path article in the page -- [ ] make dark theme -- [ ] continue author rendering -- [ ] adding word count -- [x] refactor home.scss + +The Karzok is stored in the repository at +[sr.ht](https://sr.ht/~kogeletey/karzok) and mirror +[github](https://github.com/kogeletey/karzok) > Thank you so much for any help diff --git a/docs/content/themes/lightspeed/index.md b/docs/content/themes/lightspeed/index.md index b0b5c718a3..11fd8e900b 100644 --- a/docs/content/themes/lightspeed/index.md +++ b/docs/content/themes/lightspeed/index.md @@ -3,11 +3,11 @@ title = "lightspeed" description = "Zola theme with a perfect Lighthouse score" template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/carpetscheme/lightspeed" homepage = "https://github.com/carpetscheme/lightspeed" minimum_version = "0.10.0" @@ -42,7 +42,7 @@ Demo: [quirky-perlman-34d0da.netlify.com](https://quirky-perlman-34d0da.netlify. - [Footer menu](#footer-menu) - [SEO](#seo) - [Footer text](#footer-text) - - [Sass](#Sass) + - [Sass](#sass) - [Original](#original) - [License](#license) diff --git a/docs/content/themes/ntun/index.md b/docs/content/themes/ntun/index.md index ab47f0cbd6..6be480111b 100644 --- a/docs/content/themes/ntun/index.md +++ b/docs/content/themes/ntun/index.md @@ -3,11 +3,11 @@ title = "ntun-zola-theme" description = "A classic resume theme" template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/Netoun/ntun" homepage = "https://github.com/netoun/ntun" minimum_version = "0.1.0" diff --git a/docs/content/themes/oceanic-zen/index.md b/docs/content/themes/oceanic-zen/index.md index cd029be636..80900cc5d3 100644 --- a/docs/content/themes/oceanic-zen/index.md +++ b/docs/content/themes/oceanic-zen/index.md @@ -3,11 +3,11 @@ title = "Oceanic Zen" description = "Minimalistic blog theme" template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/barlog-m/oceanic-zen.git" homepage = "https://github.com/barlog-m/oceanic-zen" minimum_version = "0.12.0" diff --git a/docs/content/themes/papaya/index.md b/docs/content/themes/papaya/index.md index 0ce1ed965a..f35d57caab 100644 --- a/docs/content/themes/papaya/index.md +++ b/docs/content/themes/papaya/index.md @@ -3,11 +3,11 @@ title = "Papaya" description = "A clean Zola theme for blogging and projects" template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/justint/papaya.git" homepage = "https://github.com/justint/papaya" minimum_version = "0.14.0" @@ -36,6 +36,8 @@ A clean [Zola](https://getzola.org) theme for blogging and projects, forked from - Blog posts - Project pages - Categories and tags +- Multilingual support +- Customizable sections and navigation menu links - Featured images for posts/pages - Smart image embedding shortcode (`{{/* img() */}}`) - GitHub repository star/fork counts @@ -65,8 +67,9 @@ A clean [Zola](https://getzola.org) theme for blogging and projects, forked from { name = "tags" }, ] ``` + 4. In your `content` directory, add new `blog` and `projects` directories. Copy the `_index.md` file from Papaya's `content/blog` into your `content/blog`, and the `_index.md` and `categories.json` files from Papaya's `content/projects` into your `content/projects`. - + Your `content` directory structure should look like this: ``` content @@ -76,7 +79,7 @@ A clean [Zola](https://getzola.org) theme for blogging and projects, forked from └── _index.md └── categories.json ``` - + 5. _(optional)_ To enable GitHub repository stars/fork counts (disabled by default to avoid hitting API rate limits), set the `$ZOLA_ENV` environment variable to `prod` prior to your `zola serve`/`zola build` execution. For csh/tsch: @@ -93,37 +96,283 @@ A clean [Zola](https://getzola.org) theme for blogging and projects, forked from Here are the customizable features of Papaya: -- Navigation menu links -- Post/project date formats -- Post/project featured images -- Project categories -- Open Graph Protocol locale/profile information -- Social/contact links +- [Project categories](#project-categories) +- [Multilingual support](#multilingual-support) +- [Custom sections and navigation menu links](#custom-sections-and-navigation-menu-links) +- [Post/project date formats](#postproject-date-formats) +- [Post/project featured images](#postproject-featured-images) +- [Open Graph Protocol locale/profile information](#open-graph-protocol-localeprofile-information) +- [Social/contact links](#socialcontact-links) -### Navigation menu links +### Project categories -In your `config.toml` under the `[extra]` section you need to set the `papaya_menu_links` list. +In your `content/projects/categories.json`, you can specify the categories of projects. The formatting of the file is: -Example: +```json +{ + "title": "keyword" +} +``` + +- `"title"`: the title text displayed for each category grouping on your projects page. +- `"keyword"`: the taxonomy term you'll use in your project pages. + +A project can have multiple categories, and will be displayed once in each category configured. + +Projects without categories will be displayed in the "Other" category listing of your project page. If you don't want the "Other" category displayed, you can copy the `templates/projects.html` to your own `templates` directory and delete/comment out the "Other" category code. + +Example `categories.json`: + +```json +{ + "Software": "software", + "Films": "film" +} +``` + +Example project page front matter: + +```toml +title = "Example software project" +date = 2021-08-11 + +[taxonomies] +categories = ["software"] +``` + +The example project page above would be grouped into & displayed within the "Software" category of your projects page. + +### Multilingual support + +Currently Zola has a basic internationalization (i18n) support, you can see this at [zola doc](https://www.getzola.org/documentation/content/multilingual/). + +To write a multilingual site, follow the steps below (English and Chinese in this example): + +1. Add a `default_language` configuration and `[languages.zh]` and `[languages.en]` sections to your `config.toml`: + + ```toml + default_language = "en" + + [languages] + + [languages.en] + + [languages.zh] + title = "中文标题" + description = "中文描述" + ``` + + Under the `[languages.zh]` section you can override default configurations like `title`, `description`, etc. + +2. Add translations of all keywords in `[languages.zh.translations]` and `languages.en.translations]` sections (see Papaya's [`config.toml`](config.toml) for a listing of all keywords): + + ```toml + [languages] + + [languages.en] + + [languages.en.translations] + projects = "Projects" + blog = "Blog" + about = "About" + recent_projects = "Recent Projects" + more_projects = "More Projects" + recent_blog_posts = "Recent Blog Posts" + more_blog_posts = "More blog posts" + ... + + [languages.zh] + + [languages.zh.translations] + projects = "项目" + blog = "博文" + about = "关于" + recent_projects = "近期项目" + more_projects = "更多项目" + recent_blog_posts = "近期博文" + more_blog_posts = "更多博文" + ... + ``` + +3. Add a `_index.zh.md` file into every section. + + For example: add `content/blog/_index.zh.md` and `content/projects/_index.zh.md`. + +4. Provide a `{page-name}.zh.md` (or `index.zh.md` into the page's directory, if it has one) for every page you'd like to translate. + + For example: add `content/blog/what-is-zola.zh.md` and `content/blog/blog-with-image/index.zh.md`. + +6. Add a `content/categories.zh.json` file. For example: + + ```json + { + "软件": "software", + "电影": "film" + } + ``` + +Now you will have a website that supports both English and Chinese! Since `default_language` in `config.toml` is set to "en", by visiting `{base_url}` you will see the English version of this blog. You can visit the Chinese version by visiting `{base_url}/zh`. + +A page (post or project) can be available in both languages or only in one language, and it's not necessary that a page is available in the default language. + +### Custom sections and navigation menu links + +The navigation menu is constructed from a list of `menu_items` in your `config.toml`. For example: +```toml +[extra] + +menu_items = [ + { name = "projects", url = "$LANG_BASE_URL/projects", show_recent = true, recent_items = 3, recent_trans_key = "recent_projects", more_trans_key = "more_projects" }, + { name = "blog", url = "$LANG_BASE_URL/blog", show_recent = true, recent_items = 3, recent_trans_key = "recent_blog_posts", more_trans_key = "more_blog_posts" }, + { name = "tags", url = "$LANG_BASE_URL/tags" }, + { name = "about", url = "$LANG_BASE_URL/about" }, +] +``` + +A `menu_item` can be one of two things: + +- **a link to a section.** Section links can be optionally configured to display its most recently authored items on your index page. See [Configuring section menu items](#configuring-section-menu-items). + +- **a link to a URL.** See [Configuring URL menu items](#configuring-url-menu-items) + +#### Configuring section menu items + +A section is created whenever a directory (or subdirectory) in the content section contains an `_index.md` file; see the [Zola docs on sections](https://www.getzola.org/documentation/content/section/). + +Papaya has two sections by default: `projects` and `blog`. You can add additional sections or change section names. For example, you can add a section called _Diary_. In order to add this section, you need to: + +1. Create a directory called `diary` in `content/`. + +2. Create an `_index.md` inside `content/diary/`, for example: + + ```toml + +++ + title = "Diary" + render = true + # diary will use blog.html for its template + template = "blog.html" + +++ + ``` + +Sections can be added to the navigation menu, and optionally configured to display its most recently authored items on your index page. To add your section to the navigation menu: + +1. In your `config.toml` under the `[extra]` section, add your section to the `menu_items`: + + ```toml + [extra] + menu_items = [ + ... + { name = "diary", url = "$LANG_BASE_URL/diary" } + ] + ``` + +2. In your `config.toml` under the `[languages..translations]` section, add your section name translation keys: + + ```toml + [languages] + + [languages.en] + + [languages.en.translations] + diary = "Diary" + + [languages.zh] + + [languages.zh.translations] + diary = "日记" + ``` + + This will add a simple hyperlink to your new _Diary_ section in the navigation menu. + +To also display recently authored items from your _Diary_ section on your index page: + +1. Add the following attributes to your menu item: + + - `show_recent`: Adds the section's recent items listing to your index page. + - `recent_items`: Number of recent items to display. + - `recent_trans_key`: Translation key for the recent items listing title text. + - `more_trans_key`: Translation key for the hyperlink text to the section. + + For example: + + ```toml + [extra] + menu_items = [ + ... + { name = "diary", url = "$LANG_BASE_URL/diary", show_recent = true, recent_items = 3, recent_trans_key = "recent_diary", more_trans_key = "more_diary" } + ] + ``` + +2. In your `config.toml` under the `[languages..translations]` section, add your section name, `recent_trans_key`, and `more_trans_key` translation keys: + + ```toml + [languages] + + [languages.en] + + [languages.en.translations] + diary = "Diary" + recent_diary = "Recent Diaries" + more_diary = "More Diaries" + + [languages.zh] + + [languages.zh.translations] + diary = "日记" + recent_diary = "近期日记" + more_diary = "更多日记" + ``` + + This will add both a hyperlink to your new _Diary_ section in the navigation menu, and a listing of the three most recent items from your _Diary_ section on your index page. + +#### Configuring URL menu items + +If you want to add a simple link to the navigation menu, add an item with a `name` and `url`. For example: ```toml [extra] -papaya_menu_links = [ - { url = "$BASE_URL/about/", name = "About" }, +sections = [ + ... + { name = "tag", url = "$LANG_BASE_URL/tags" } ] ``` -If you include `$BASE_URL` in the URL of a link it will be replaced with the base URL of your site. +A translation key for your link's `name` must be added into your `config.toml`: + +```toml +[languages] + +[languages.en] + +[languages.en.translations] +tag = "Tag" + +[languages.zh] + +[langauges.zh.translations] +tag = "标签" +``` + +If you include `$BASE_URL` in the URL of a link it will be replaced with the base URL of your site, and `$LANG_BASE_URL` will be replaced with the language-specific base URL of your site. ### Post/project date formats -In your `config.toml` under the `[extra]` section you need to set the `papaya_date_format` value. +You can have different date formats in different languages. You need to set the `date_format` value in every langauge's translation section. Example: ```toml -[extra] -papaya_date_format = "%e %B %Y" +[languages] + +[languages.en] + +[languages.en.translations] +date_format = "%e %B %Y" + +[languages.zh] + +[languages.zh.translations] +date_format = "%Y 年 %m 月 %d 日" ``` The formatting uses the standard `date` filter in Tera. The date format options you can use are listed in the [chrono crate documentation](https://tera.netlify.app/docs/#date). @@ -151,44 +400,6 @@ featured_image_extended = true ![Featured image, extended](pics/featured_image_extended.png) - -### Project categories - -In your `content/projects/categories.json`, you can specify the categories of projects. The formatting of the file is: - -```json -{ - "title": "keyword" -} -``` - -- `"title"`: the title text displayed for each category grouping on your projects page. -- `"keyword"`: the taxonomy term you'll use in your project pages. - -A project can have multiple categories, and will be displayed once in each category configured. - -Projects without categories will be displayed in the "Other" category listing of your project page. If you don't want the "Other" category displayed, you can copy the `templates/projects.html` to your own `templates` directory and delete/comment out the "Other" category code. - -Example `categories.json`: - -```json -{ - "Software": "software", - "Films": "film" -} -``` - -Example project page front matter: -```toml -title = "Example software project" -date = 2021-08-11 - -[taxonomies] -categories = ["software"] -``` - -The example project page above would be grouped into & displayed within the "Software" category of your projects page. - ### Open Graph Protocol locale/profile information In your `config.toml` you can add a `[extra.ogp]` section to specify your Open Graph Protocol locale and profile information. @@ -219,6 +430,27 @@ Example: email = "papaya@tiliqua.sp" github = "papaya" linkedin = "papayatiliqua" +twitter = "papayathehisser" +``` + +If you want to include other custom social websites, you can add them to `other`: + +Example: + +```toml +[extra.social] +other = [ + { name = "BTC", font_awesome = "fa-brands fa-btc", url = "https://www.bitcoin.com/" } +] +``` + +The `font_awesome` attribute specifies the Font Awesome classes; you can find them in [Font Awesome](https://fontawesome.com/). Be aware that different versions of Font Awesome may include different sets of icons; you can change your version of Font Awesome by updating the CDN path in the `[extra.cdn]` section: + +```toml +[extra] + +[extra.cdn] +font_awesome = "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0-beta2/css/all.min.css" ``` ## Image embedding shortcode @@ -226,15 +458,21 @@ linkedin = "papayatiliqua" Included with Papaya is a shortcode for embedding images into your posts: ``` -img(path, alt, caption, class, extended_width_pct) +img(path, alt, caption, class, extended_width_pct, quality) ``` +You can use `./` to specify the relative path of image which is relative to current markdown file. + ### Arguments -- `path`: The path to the image relative to the `content` directory in the [directory structure](https://www.getzola.org/documentation/getting-started/directory-structure/). +- `path`: The path to the image. It can be either: + - a full path (eg: `https://somesite.com/my-image.jpg`), + - relative to the `content` directory in the [directory structure](https://www.getzola.org/documentation/getting-started/directory-structure/) (eg: `@/projects/project-1/my-image.jpg`), or + - relative to the current markdown file (eg: `./my-image.jpg`). - `alt`: _(optional)_ The alternate text for the image. - `caption`: _(optional)_ A caption for the image. Text/HTML/Tera templates supported. - `class`: _(optional)_ Any CSS classes to assign to the image. Multiple classes should be separated with a space (`" "`). +- `quality`: _(optional)_ JPEG or WebP quality of the image, in percent. Only used when encoding JPEGs or WebPs; default value is `90`. - `extended_width_pct`: _(optional)_ The percentage by which the image's width should be expanded past it's default figure width, up to maximum configured pixel width. Range is `0.0-1.0`, or `-1` for document width. @@ -265,7 +503,7 @@ By default, images embedded with the `img` shortcode will be inserted as a `figu ![Default sized image](pics/img_default.png) -With the `extended_width_pct` argument, we can specify a percentage of how much the image should expand outside its default figure width, up to your maximum configured image width (`config.extras.images.max_width`, 2500px default). +With the `extended_width_pct` argument, we can specify a percentage of how much the image should expand outside its default figure width, up to your maximum configured image width (`config.extra.images.max_width`, 2500px default). Here's an example with `extended_width_pct=0.1`: diff --git a/docs/content/themes/resume/index.md b/docs/content/themes/resume/index.md new file mode 100644 index 0000000000..05582413c2 --- /dev/null +++ b/docs/content/themes/resume/index.md @@ -0,0 +1,166 @@ + ++++ +title = "resume" +description = "A resume theme" +template = "theme.html" +date = 2022-01-23T23:20:14+01:00 + +[extra] +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 +repository = "https://github.com/AlongWY/zola-resume.git" +homepage = "https://github.com/alongwy/zola-resume" +minimum_version = "0.11.0" +license = "MIT" +demo = "https://resume.alongwy.top" + +[extra.author] +name = "Feng Yunlong" +homepage = "https://www.alongwy.top" ++++ + +# Zola Resume + +[Chinese Version](README.CN.md) + +Redesigned form [hugo resume](https://github.com/eddiewebb/hugo-resume). + +## Features ++ This is basically a single-page website with auto-scrolling based on left-hand nav. ++ Dedicated project/publications pages allow more detail. ++ Includes a client-side search at '/search'. ++ Includes an `/admin` endpoint that can allow authorized users to use a WYSIWYG editor and commit files back to markdown, but with a Wordpress/CMS like experience. + +## Quick Start + +```bash +git clone git@github.com:alongwy/zola-resume.git +cd zola-resume +zola serve +# open http://127.0.0.1:1111/ +``` + +## Installation +Just earlier we showed you how to run the theme directly. Now we start to install the theme in an existing site step by step. + +### Step 1: Create a new zola site + +```bash +zola init mysite +``` + +### Step 2: Install zola-resume +Download this theme to your themes directory: + +```bash +cd mysite/themes +git clone git@github.com:alongwy/zola-resume.git +``` + +Or install as a submodule: + +```bash +cd mysite +git init # if your project is a git repository already, ignore this command +git submodule add git@github.com:alongwy/zola-resume.git themes/zola-resume +``` + +### Step 3: Configuration +Enable the theme in your config.toml in the site derectory: + +```toml +theme = "zola-resume" +``` + +Or copy the config.toml.example from the theme directory to your project's root directory: + +```bash +cp themes/zola-resume/config.toml.example config.toml +``` + +#### For CMS + +```bash +cp themes/zola-resume/static/admin/config.yml static/admin/config.yml +``` + +and change those + +```yaml +# static/admin/config.yml + +backend: + name: github + repo: USERNAME/REPO + branch: BRANCH + cms_label_prefix: netlify-cms/ + site_domain: DOMAIN.netlify.com +``` + +### Step 4: Add new content +You can copy the content from the theme directory to your project: + +``` +cp -r themes/zola-resume/data . +cp -r themes/zola-resume/content . +``` + +You can modify or add new posts in the content/blog, content/projects or other content directories as needed. + +### Step 5: Run the project +Just run zola serve in the root path of the project: + +``` +zola serve +``` + +This will start the Zola development web server accessible by default at http://127.0.0.1:1111. Saved changes will live reload in the browser. + +## Examples + +![screenshot](https://raw.githubusercontent.com/alongwy/zola-resume/master/screenshot.png) + +See [along's site](https://resume.alongwy.top) for a live example. + +## Setup & Use + +This theme uses a combination of custom sections and some data files to drive content. + +### Summary +Edit the main `contents/_index.md with a brief bio/summary` + +### Data files +Data files are used for simple content presented on the homepage. + +- [data/certifications.json](https://github.com/AlongWY/zola-resume/blob/main/data/certifications.json) +- [data/social.json](https://github.com/AlongWY/zola-resume/blob/main/data/social.json) +- [data/skills.json](https://github.com/AlongWY/zola-resume/blob/main/data/skills.json) +- [data/experience.json](https://github.com/AlongWY/zola-resume/blob/main/data/experience.json) +- [data/education.json](https://github.com/AlongWY/zola-resume/blob/main/data/education.json) + +### Projects/Opensource + +The difference indicates your role as originator or colaborator. + +### Publications +Similar to projects, create them under `publications`. Include any papers, speaking engagements, articles, etc. + +### Blog / Posts +Similar to posts, create them under `blog`. Include any thoughts, musiings, etc. +**This template does not support a `posts` folder** + +### Template params + +Almost All personal information outside the above details is captured by extra in [`config.toml`](https://github.com/AlongWY/zola-resume/blob/main/config.toml), or can be edited in the "Settings" collection if using CMS. + +## CMS Editor with Netlify CMS +**Does not require deployment to Netlify!** + +[Netlify CMS](https://www.netlifycms.org/) is an open source project that enables CMS like experience for static site generation tools like Hugo. This theme includes a fully working integration and guide in [static/admin](https://github.com/AlongWY/zola-resume/tree/main/static/admin) + +## Credits + +This project ports the Hugo Resume theme by Feng Yunlong to support zola. + + + \ No newline at end of file diff --git a/docs/content/themes/resume/screenshot.png b/docs/content/themes/resume/screenshot.png new file mode 100644 index 0000000000..130e74dadc Binary files /dev/null and b/docs/content/themes/resume/screenshot.png differ diff --git a/docs/content/themes/sam/index.md b/docs/content/themes/sam/index.md index 0692b840d0..6e7ba21cba 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 = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01: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/serene/index.md b/docs/content/themes/serene/index.md index 24f4dbe0ae..25e53ae383 100644 --- a/docs/content/themes/serene/index.md +++ b/docs/content/themes/serene/index.md @@ -3,11 +3,11 @@ title = "serene" description = "A blog theme for zola, simple and clean." template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/isunjn/serene.git" homepage = "https://github.com/isunjn/serene" minimum_version = "0.9.0" @@ -19,7 +19,7 @@ name = "isunjn" homepage = "https://github.com/isunjn" +++ -English | [简体中文](README-cn.md) +English | [简体中文](https://github.com/isunjn/serene/blob/main/README-cn.md) # Serene - A blog theme for zola @@ -32,13 +32,13 @@ Serene is a simple and clean blog theme for Static-Site-Generator [Zola](https:/
Click to see screenshots - ![](screenshots/1.png) - ![](screenshots/2.png) - ![](screenshots/3.png) - ![](screenshots/4.png) - ![](screenshots/5.png) - ![](screenshots/6.png) - ![](screenshots/7.png) + ![](https://github.com/isunjn/serene/blob/main/screenshots/1.png?raw=true) + ![](https://github.com/isunjn/serene/blob/main/screenshots/2.png?raw=true) + ![](https://github.com/isunjn/serene/blob/main/screenshots/3.png?raw=true) + ![](https://github.com/isunjn/serene/blob/main/screenshots/4.png?raw=true) + ![](https://github.com/isunjn/serene/blob/main/screenshots/5.png?raw=true) + ![](https://github.com/isunjn/serene/blob/main/screenshots/6.png?raw=true) + ![](https://github.com/isunjn/serene/blob/main/screenshots/7.png?raw=true)
## Features @@ -80,6 +80,6 @@ Be noticed that to keep serene simple, some needs may not be considered. You can ## License -[MIT](LICENSE) +[MIT](https://github.com/isunjn/serene/blob/main/LICENSE) \ No newline at end of file diff --git a/docs/content/themes/simple-dev-blog/index.md b/docs/content/themes/simple-dev-blog/index.md index 08570005a1..582fa9e380 100644 --- a/docs/content/themes/simple-dev-blog/index.md +++ b/docs/content/themes/simple-dev-blog/index.md @@ -3,11 +3,11 @@ title = "simple-dev-blog" description = "A simple dev blog theme with no javascript, prerendered linked pages and SEO tags." template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+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" diff --git a/docs/content/themes/slim/index.md b/docs/content/themes/slim/index.md index a727174cf2..086a444860 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 = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01: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 index 7f7a7d240a..137c9b0b5d 100644 --- a/docs/content/themes/solar-theme-zola/index.md +++ b/docs/content/themes/solar-theme-zola/index.md @@ -3,11 +3,11 @@ title = "solar-theme-zola" description = "A port of solar-theme-hugo for zola" template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/hulufei/solar-theme-zola.git" homepage = "https://github.com/hulufei/solar-theme-zola" minimum_version = "0.4.0" diff --git a/docs/content/themes/tale-zola/index.md b/docs/content/themes/tale-zola/index.md index 1177a073a8..1e26bd4c94 100644 --- a/docs/content/themes/tale-zola/index.md +++ b/docs/content/themes/tale-zola/index.md @@ -3,11 +3,11 @@ title = "tale-zola" description = "Tala-Zola is a minimal Zola theme helping you to build a nice and seo-ready blog." template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/aaranxu/tale-zola.git" homepage = "https://github.com/aaranxu/tale-zola" minimum_version = "0.13.0" @@ -207,7 +207,7 @@ disqus = false disqus_id = "" ``` -Code syntax highlighting. See also [syntax hightlighting](https://www.getzola.org/documentation/getting-started/configuration/#syntax-highlighting). +Code syntax highlighting. See also [syntax highlighting](https://www.getzola.org/documentation/getting-started/configuration/#syntax-highlighting). ```toml [markdown] diff --git a/docs/content/themes/toucan/index.md b/docs/content/themes/toucan/index.md index 6b16171cd3..fbdde0cbaf 100644 --- a/docs/content/themes/toucan/index.md +++ b/docs/content/themes/toucan/index.md @@ -3,11 +3,11 @@ title = "Toucan" description = "Inspired from Pelican default theme" template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://git.42l.fr/HugoTrentesaux/toucan.git" homepage = "https://git.42l.fr/HugoTrentesaux/toucan" minimum_version = "0.8.0" diff --git a/docs/content/themes/zerm/index.md b/docs/content/themes/zerm/index.md index 275dad61ed..964d49c93e 100644 --- a/docs/content/themes/zerm/index.md +++ b/docs/content/themes/zerm/index.md @@ -3,11 +3,11 @@ title = "zerm" description = "A minimalistic and dark theme based on Radek Kozieł's theme for Hugo" template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/ejmg/zerm.git" homepage = "https://github.com/ejmg/zerm" minimum_version = "0.8.0" @@ -56,6 +56,27 @@ theme](https://www.getzola.org/documentation/themes/installing-and-using-themes/ 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)! +## math +You can use KaTeX for mathematical typesetting. +Assets are only available if you opt-in on a per-page level through +a single line (`math=true`) on the extra section of the page frontmatter. + +``` md +# index.md ++++ +title="this page title" +... + +[extra] +math=true ++++ + +Content +``` + +Pages wich doesn't opt-in are not affected in any way, so you doesn't have +to worry about any performance hit. + ## license MIT. See `LICENSE.md` for more details. diff --git a/docs/content/themes/zola-henry/index.md b/docs/content/themes/zola-henry/index.md index b808e483fe..e37c7afb9a 100644 --- a/docs/content/themes/zola-henry/index.md +++ b/docs/content/themes/zola-henry/index.md @@ -3,11 +3,11 @@ title = "henry" description = "A timeless blog theme" template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/sirodoht/zola-henry" homepage = "https://github.com/sirodoht/zola-henry" minimum_version = "0.4.0" diff --git a/docs/content/themes/zola-paper/index.md b/docs/content/themes/zola-paper/index.md index 76e2503235..ca1b508284 100644 --- a/docs/content/themes/zola-paper/index.md +++ b/docs/content/themes/zola-paper/index.md @@ -3,11 +3,11 @@ title = "zola-paper" description = "A clean theme inspired from hugo-paper." template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/schoenenberg/zola-paper.git" homepage = "https://github.com/schoenenberg/zola-paper" minimum_version = "0.11.0" diff --git a/docs/content/themes/zola-pickles/index.md b/docs/content/themes/zola-pickles/index.md index de26b42d1d..e4c36cf968 100644 --- a/docs/content/themes/zola-pickles/index.md +++ b/docs/content/themes/zola-pickles/index.md @@ -3,11 +3,11 @@ title = "pickles" description = "A modern, simple, clean blog theme for Zola." template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/lukehsiao/zola-pickles.git" homepage = "https://github.com/lukehsiao/zola-pickles" minimum_version = "0.13.0" diff --git a/docs/content/themes/zola-theme-hikari/index.md b/docs/content/themes/zola-theme-hikari/index.md index bd644a2cd6..aeb1c32d04 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 = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/waynee95/zola-theme-hikari" homepage = "https://github.com/waynee95/zola-theme-hikari" minimum_version = "0.5.1" diff --git a/docs/content/themes/zola.386/index.md b/docs/content/themes/zola.386/index.md index 1300e4aa78..a80c92d907 100644 --- a/docs/content/themes/zola.386/index.md +++ b/docs/content/themes/zola.386/index.md @@ -3,11 +3,11 @@ title = "zola.386" description = "Zola port of the BOOTSTRA.386 theme." template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/lopes/zola.386" homepage = "https://github.com/lopes/zola.386" minimum_version = "0.10.1" diff --git a/docs/content/themes/zola_easydocs_theme/index.md b/docs/content/themes/zola_easydocs_theme/index.md index 4f30e0dfc2..e31d7d3ce1 100644 --- a/docs/content/themes/zola_easydocs_theme/index.md +++ b/docs/content/themes/zola_easydocs_theme/index.md @@ -3,11 +3,11 @@ title = "EasyDocs" description = "An easy way to create docs for your project" template = "theme.html" -date = 2022-01-17T03:13:30+08:00 +date = 2022-01-23T23:20:14+01:00 [extra] -created = 2022-01-17T03:13:30+08:00 -updated = 2022-01-17T03:13:30+08:00 +created = 2022-01-23T23:20:14+01:00 +updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/codeandmedia/zola_easydocs_theme.git" homepage = "https://github.com/codeandmedia/zola_easydocs_theme" minimum_version = "0.13.0"