diff --git a/docs/content/themes/DeepThought/index.md b/docs/content/themes/DeepThought/index.md index 1bc1eb4441..e6e6591cbc 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 = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/RatanShreshtha/DeepThought.git" homepage = "https://github.com/RatanShreshtha/DeepThought" minimum_version = "0.14.1" @@ -19,59 +19,97 @@ name = "Ratan Kulshreshtha" homepage = "https://ratanshreshtha.dev" +++ -

- - Logo - - -

DeepThought

+
-

+ logo +

DeepThought

+ +

A simple blog theme focused on writing powered by Bulma and Zola. -
- Explore the docs » -
-
- Code Repository - · - Report Bug - · - Request Feature

+ + + +

+ + contributors + + + last update + + + forks + + + stars + + + open issues + + + license +

- -
-

Table of Contents

 -
    -
  1. - About The Project - -
    2. -
  2. - Getting Started - -
    3. -
  3. Usage
    4. -
  4. Roadmap
    5. -
  5. Contributing
    6. -
  6. License
    7. -
  7. Contact
    8. -
  8. Acknowledgements
    9. -
-
- -## About The Project - -[![DeepThought](./screenshot.png)](https://deepthought-theme.netlify.app/) - -> A simple blog theme focused on writing powered by Bulma and Zola. - -### Features + +

+ View Demo + · + Documentation + · + Report Bug + · + Request Feature +

+
+ +
+ + +# :notebook_with_decorative_cover: Table of Contents + +- :notebook_with_decorative_cover: Table of Contents + - :star2: About the Project + - :camera: Screenshots + - :space_invader: Tech Stack + - :dart: Features + - :toolbox: Getting Started + - :bangbang: Prerequisites + - :gear: Installation + - :running: Run Locally + - :triangular_flag_on_post: Deployment + - :eyes: Usage + - Multilingual Navbar + - KaTeX math formula support + - Automatic rendering without short codes + - Elasticlunr search in other language + - :wave: Contributing + - :warning: License + - :handshake: Contact + - :gem: Acknowledgements + + + + +## :star2: About the Project + + + +### :camera: Screenshots + +
+ screenshot +
+ + + +### :space_invader: Tech Stack + + +- [Zola](https://www.getzola.org/) - Your one-stop static site engine +- [Bulma](https://bulma.io/) - The modern CSS framework that just works. + + +### :dart: Features - [x] Dark Mode - [x] Pagination @@ -87,20 +125,16 @@ homepage = "https://ratanshreshtha.dev" - [x] Multilingual Navbar - [x] Katex -### Built With + +## :toolbox: Getting Started -- [Zola](https://www.getzola.org/) -- [Bulma](https://bulma.io/) - -## Getting Started - -To get a local copy up and running follow these simple steps. - -### Prerequisites + +### :bangbang: Prerequisites You need static site generator (SSG) [Zola](https://www.getzola.org/documentation/getting-started/installation/) installed in your machine to use this theme follow their guide on [getting started](https://www.getzola.org/documentation/getting-started/overview/). -### Installation + +### :gear: Installation Follow zola's guide on [installing a theme](https://www.getzola.org/documentation/themes/installing-and-using-themes/). Make sure to add `theme = "DeepThought"` to your `config.toml` @@ -108,19 +142,22 @@ Make sure to add `theme = "DeepThought"` to your `config.toml` **Check zola version (only 0.9.0+)** Just to double-check to make sure you have the right version. It is not supported to use this theme with a version under 0.14.1. -## Usage - -### How to serve? + +### :running: Run Locally Go into your sites directory and type `zola serve`. You should see your new site at `localhost:1111`. **NOTE**: you must provide the theme options variables in `config.toml` to serve a functioning site -### Deployment + +### :triangular_flag_on_post: Deployment [Zola](https://www.getzola.org) already has great documentation for deploying to [Netlify](https://www.getzola.org/documentation/deployment/netlify/) or [Github Pages](https://www.getzola.org/documentation/deployment/github-pages/). I won't bore you with a regurgitated explanation. -### Theme Options + +## :eyes: Usage + +Following options are available with the `DeepThought` theme ```toml # Enable external libraries @@ -169,7 +206,8 @@ instagram = "" behance = "" google_scholar = "" orcid = "" -mastodon = "" +mastodon_username = "" +mastodon_server = "" (if not set, defaults to mastodon.social) # To add google analytics @@ -272,34 +310,45 @@ e.g. `templates/base.html` More detailed explanations are aound in [elasticlunr's documents](https://github.com/weixsong/elasticlunr.js#other-languages-example-in-browser). -## Roadmap + +## :wave: Contributing + + + + -See the [open issues](https://github.com/RatanShreshtha/DeepThought/issues) for a list of proposed features (and known issues). -## Contributing +Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. -Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. +- Fork the Project +- Create your Feature Branch (git checkout -b feature/AmazingFeature) +- Commit your Changes (git commit -m 'Add some AmazingFeature') +- Push to the Branch (git push origin feature/AmazingFeature) +- Open a Pull Request -1. Fork the Project -2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) -3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) -4. Push to the Branch (`git push origin feature/AmazingFeature`) -5. Open a Pull Request + +## :warning: License -## License +Distributed under the MIT License. See `LICENSE` for more information. -Distributed under the MIT License. See `LICENSE` for more information. -## Contact + +## :handshake: Contact -Ratan Kulshreshtha - [@RatanShreshtha](https://twitter.com/RatanShreshtha)> +Ratan Kulshreshtha - [@RatanShreshtha](https://twitter.com/RatanShreshtha) - ratan.shreshtha[at]gmail.com Project Link: [https://github.com/RatanShreshtha/DeepThought](https://github.com/RatanShreshtha/DeepThought) -## Acknowledgements -- [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet) + +## :gem: Acknowledgements + +Use this section to mention useful resources and libraries that you have used in your projects. + +- [Shields.io](https://shields.io/) - [Choose an Open Source License](https://choosealicense.com) +- [Awesome README](https://github.com/matiassingers/awesome-readme) +- [Emoji Cheat Sheet](https://github.com/ikatyang/emoji-cheat-sheet/blob/main/README.md#travel--places) - [Slick Carousel](https://kenwheeler.github.io/slick) - [Font Awesome](https://fontawesome.com) - [Unsplash](https://unsplash.com/) diff --git a/docs/content/themes/DeepThought/screenshot.png b/docs/content/themes/DeepThought/screenshot.png index 9b59837825..420203eae0 100644 Binary files a/docs/content/themes/DeepThought/screenshot.png and b/docs/content/themes/DeepThought/screenshot.png differ diff --git a/docs/content/themes/Ergo/index.md b/docs/content/themes/Ergo/index.md index 2074117ebc..6e45cf4a56 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 = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/insipx/Ergo.git" homepage = "https://github.com/insipx/Ergo" minimum_version = "0.4.1" diff --git a/docs/content/themes/HayFlow/index.md b/docs/content/themes/HayFlow/index.md index dd1776998b..549a499d9b 100644 --- a/docs/content/themes/HayFlow/index.md +++ b/docs/content/themes/HayFlow/index.md @@ -3,11 +3,11 @@ title = "HayFlow" description = "HayFlow is a minimal and completely modular Zola theme for anyone wishing to have their own landing page." template = "theme.html" -date = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://gitlab.com/cyril-marpaud/hayflow.git" homepage = "https://gitlab.com/cyril-marpaud/hayflow" minimum_version = "0.4.0" @@ -54,35 +54,49 @@ cd mywebsite git clone git@gitlab.com:cyril-marpaud/hayflow.git themes/hayflow ``` -Add `theme = "hayflow"` at the top of your `config.toml` file to tell Zola to use HayFlow (as described in [the documentation](https://www.getzola.org/documentation/themes/installing-and-using-themes/)). +Add `theme = "hayflow"` at the top of `config.toml` file to tell Zola to use HayFlow (as described in [the documentation](https://www.getzola.org/documentation/themes/installing-and-using-themes/)). Finally, run... ```bash zola serve ``` -...and go to [http://localhost:1111](http://localhost:1111) to see your landing page in action with the default name displayed (John Doe). +...and go to [http://localhost:1111](http://localhost:1111) to see the landing page in action with the default name displayed (John Doe). ## Landing page customization -Customizing the landing page boils down to adding variables to your `config.toml`'s `[extra]` section. There are three variables one can use to do so: `name`, `roles` and `links` (they are all optional). +Customizing the landing page boils down to two things: + +- adding the `name` and `links` variables to the `config.toml`'s `[extra]` section (`links` is optional. So is `name` if your name is John Doe) +- adding the `roles` variable to the `content/_index.md`'s `[extra]` section (also optional) + +The difference comes from the fact that you might need to translate the `roles` into other languages. For that to be possible, they must be placed in a MarkDown file. See multilingual support for more info. - `name` speaks for itself. - `roles` is an array of strings. Each string is displayed on a separate line. - `links` is an array of `{icon, url}` objects. You can use any **free** icon from [Font Awesome](https://fontawesome.com/search?o=r&m=free) here, all you need is the icon's code. The [enveloppe icon](https://fontawesome.com/icons/envelope?s=solid&f=classic)'s code is `fa-solid fa-envelope`. The [pizza-slice icon](https://fontawesome.com/icons/pizza-slice?s=solid&f=classic)'s code is `fa-solid fa-pizza-slice`. +This is what the `config.toml`'s `[extra]` section might look like after customization: + ```TOML [extra] name = { first = "ninja", last = "turtle" } -roles = ["Green 🟢", "Turtle 🐢", "Pizza enthusiast 🍕"] - links = [ { icon = "fa-solid fa-envelope", url = "mailto:slice@pizza.it" }, { icon = "fa-solid fa-pizza-slice", url = "https://en.wikipedia.org/wiki/Pizza" }, ] ``` +And here's a customized version of `content/_index.md`: + +```TOML ++++ +[extra] +roles = ["Green 🟢", "Turtle 🐢", "Pizza enthusiast 🍕"] ++++ +``` + ## Adding a section Inside the `content` directory, create a `pizza` folder and place this `_index.md` file inside: @@ -95,7 +109,7 @@ title = "Pizza" What a mouthful ! ``` -Then, add this `sections` variable (an array of strings) to your `config.toml`'s `[extra]` section: +Then, add this `sections` variable (an array of strings) to the `config.toml`'s `[extra]` section: ```TOML [extra] @@ -106,7 +120,7 @@ A new internal link pointing to that section will appear on the landing page. Cl ## Customizing sections -HayFlow currently supports three card types : `simple`, `columns` and `list`. If left unspecified, the type will default to `simple`. To change it, add a `card_type` variable to your `_index.md`'s [front matter](https://www.getzola.org/documentation/content/section/#front-matter)'s `[extra]` section: +HayFlow currently supports three card types : `simple`, `columns` and `list`. If left unspecified, the type will default to `simple`. To change it, add a `card_type` variable to the `_index.md`'s `[extra]` section: ```TOML +++ @@ -153,4 +167,90 @@ Margherita pizza is a typical [Neapolitan pizza](https://en.wikipedia.org/wiki/N The `link` variable is optional. +## Multilingual support + +HayFlow supports multilingual websites out of the box. + +### Declare more languages + +In `config.toml`, add the languages you want to support like so: + +```TOML +default_language = "fr" +[translations] +flag = "🇫🇷" + +[languages.en] +[languages.en.translations] +flag = "🇬🇧" + +[languages.italian] +[languages.italian.translations] +flag = "🇮🇹" +``` + +This will make the language-select block in the top-right corner visible. It consists of clickable links to the translated versions of your website. +The `flag` variable is optional and you can use simple text instead of an emoji flag. If left unspecified, it will default to the country code you chose for that language (`fr`, `en` and `italian` in this example). + +### Translate the content + +Each `.md` file in the `content` folder now needs to be translated into every additional language previously declared in `config.toml`. + +Following the above example (three languages, french, english and italian) and given this initial filetree: + +``` +content/ + _index.md + pizzas/ + _index.md + margherita.md + capricciosa.md +``` + +The final filetree should look like this for the translation to be complete: + +``` +content/ + _index.md + _index.en.md + _index.italian.md + pizzas/ + _index.md + _index.en.md + _index.italian.md + margherita.md + margherita.en.md + margherita.italian.md + capricciosa.md + capricciosa.en.md + capricciosa.italian.md +``` + +### List cards + +Additionally, if your website includes any "list card" sections, you might want to specify a `discover` variable in their `[extra]` sections like so: + +```TOML ++++ +title = "List Card Section" + +[extra] +card_type = "list" +discover = "Découvrir" ++++ +``` + +## Whoami + +My name is Cyril Marpaud, I'm an embedded systems freelance engineer and a Rust enthusiast 🦀 I have nearly 10 years experience and am currently living in Lyon (France). + +
+ +[![LinkedIn][linkedin-shield]][linkedin-url] + +[linkedin-url]: https://www.linkedin.com/in/cyrilmarpaud/ +[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=grey&logoColor=blue + +
+ \ No newline at end of file diff --git a/docs/content/themes/Zulma/index.md b/docs/content/themes/Zulma/index.md index bba20f84f7..71ea5e0def 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 = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/Worble/Zulma.git" homepage = "https://github.com/Worble/Zulma" minimum_version = "0.6.0" diff --git a/docs/content/themes/abridge/index.md b/docs/content/themes/abridge/index.md index 839e20de03..1db4a60dac 100644 --- a/docs/content/themes/abridge/index.md +++ b/docs/content/themes/abridge/index.md @@ -3,14 +3,14 @@ title = "abridge" description = "A fast and lightweight Zola theme using semantic html, a class-light abridge.css, and No JS." template = "theme.html" -date = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/Jieiku/abridge.git" -homepage = "https://github.com/jieiku/abridge/" -minimum_version = "0.16.0" +homepage = "https://github.com/jieiku/abridge" +minimum_version = "0.17.1" license = "MIT" demo = "https://abridge.netlify.app/" @@ -24,10 +24,12 @@ homepage = "https://github.com/jieiku/" # Abridge Zola Theme -Abridge is a fast and lightweight Zola theme using semantic html, only ~6kb css before the svg icons and syntax highlighting css, no mandatory JS[*](https://github.com/Jieiku/abridge#contributing-and-philosophy), and perfect [Lighthouse](https://web.dev/measure/?url=https%3A%2F%2Fabridge.netlify.app) and [Observatory](https://observatory.mozilla.org/analyze/abridge.netlify.app) scores. +Abridge is a fast and lightweight Zola theme using semantic html, only ~6kb css before the svg icons and syntax highlighting css, no mandatory JS[*](https://github.com/Jieiku/abridge#contributing-and-philosophy), and perfect [Lighthouse](https://pagespeed.web.dev/report?url=abridge.netlify.app), [YellowLabTools](https://yellowlab.tools/), and [Observatory](https://observatory.mozilla.org/analyze/abridge.netlify.app) scores. There is also [Abridge-minimal](https://github.com/jieiku/abridge.css) Theme which is used to showcase the [abridge.css framework](https://github.com/Jieiku/abridge.css/tree/master/dist) +Here is a [Zola Themes Benchmarks](https://github.com/Jieiku/zola-themes-benchmarks/blob/main/README.md) Page. + Maintenance of this project is made possible by all the contributors and sponsors. If you'd like to sponsor this project and have your avatar or company logo appear below click here. 💖 @@ -40,7 +42,7 @@ Maintenance of this project is made possible by all the Andromeda is a lightweight **photojournal & blog** theme designed for Zola. + +With built-in support for galleries and some options for customization, Andromeda is designed for photojournalism without complications. + +Index demo: +![Index demo graphic](index_demo.jpg) + +Post demo: +![Post demo graphic](post_demo.png) + +--- + +## Installation + +Assuming you already have a site set up (see the [Zola guide for setting up a site](https://www.getzola.org/documentation/getting-started/overview/)), + +1. Create a `themes` directory in the root of your site if it does not already exist. +2. Clone the theme into your themes directory: + ``` + git clone https://github.com/Pixadus/andromeda-theme themes/andromeda + ``` +3. Duplicate the structure of the the `config.toml` file found in `themes/andromeda/config.toml` or [this repository](https://github.com/Pixadus/andromeda-theme/blob/main/config.toml) within your own `config.toml`. + +## Creating pages + +To create a new post, create a `.md` file within `/content`, with the header format: + +```markdown ++++ +title = "Post title" +date = 2023-04-25 +description = "Post description" +extra = {header_img = "image-url"} ++++ +``` +**Note**: The +++ are necessary. + +The `header_img` field is the image shown on the homepage of the blog and in the heading of each page. It can be a remote URL or local - if local, by default this will be files stored in the `static` folder, or `/images` in the URL. + +### Galleries + +Galleries can be set up by using the following template in your Markdown file: + +```html +
+ + +
+``` + +For more or less photos, use `` tags. [Flickr](https://www.flickr.com/) provides a good hosting option as it automatically generates thumbnails for you. + +## Configuration + +Andromeda supports custom navbar links - see [config.toml](https://github.com/Pixadus/andromeda-theme/blob/main/config.toml) for an example. You may also set a custom `favicon.ico` though `config.toml`. + +If you wish to customize the design of the gallery, basic Javascript knowledge will be necessary. Andromeda uses `nanogallery2` by default - the [documentation can be found here](https://nanogallery2.nanostudio.org/documentation.html). Customizations to the gallery design are done within the `{%/* macro pagefooter() */%}` block within `/templates/macros.html`. + +By default, this script is divided into three sections (indicated by `item==`): single-image, two-image and three+ image gallery setups. + +## Credits + +The demo images used included [Antelope Canyon by Anishkumar Sugumaran](https://www.flickr.com/photos/anishkumar_sugumaran/52831738797/in/explore-2023-04-26/) and [Bryce Canyon by Marco Isler](https://www.flickr.com/photos/27263572@N05/52838617702/in/explore-2023-04-26/). + \ No newline at end of file diff --git a/docs/content/themes/andromeda/screenshot.png b/docs/content/themes/andromeda/screenshot.png new file mode 100644 index 0000000000..65c04b4c2b Binary files /dev/null and b/docs/content/themes/andromeda/screenshot.png differ diff --git a/docs/content/themes/anpu/index.md b/docs/content/themes/anpu/index.md index ee7d4e9be2..d1852c8ecc 100644 --- a/docs/content/themes/anpu/index.md +++ b/docs/content/themes/anpu/index.md @@ -3,11 +3,11 @@ title = "Anpu" description = "A port of the Hugo Anubis theme" template = "theme.html" -date = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/zbrox/anpu-zola-theme.git" homepage = "https://github.com/zbrox/anpu-zola-theme" minimum_version = "0.11.0" diff --git a/docs/content/themes/apollo/index.md b/docs/content/themes/apollo/index.md index f3d869fb69..b9dbf47b3f 100644 --- a/docs/content/themes/apollo/index.md +++ b/docs/content/themes/apollo/index.md @@ -3,11 +3,11 @@ title = "apollo" description = "Modern and minimalistic blog theme" template = "theme.html" -date = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/not-matthias/apollo.git" homepage = "https://github.com/not-matthias/apollo" minimum_version = "0.14.0" @@ -21,19 +21,19 @@ homepage = "https://github.com/not-matthias" # apollo -Modern and minimalistic blog theme powered by [Zola](getzola.org). See a live preview [here](https://not-matthias.github.io/apollo). +Modern and minimalistic blog theme powered by [Zola](https://getzola.org). See a live preview [here](https://not-matthias.github.io/apollo). Named after the greek god of knowledge, wisdom and intellect
Dark theme - + ![blog-dark](https://user-images.githubusercontent.com/26800596/168986771-4ed049e2-e123-4d0e-8a24-7bf43f47551f.png)
Light theme - + ![blog-light](https://user-images.githubusercontent.com/26800596/168986766-72a48517-7122-465d-8108-3ae33e1e88b1.png)
@@ -41,8 +41,11 @@ Modern and minimalistic blog theme powered by [Zola](getzola.org). See a live pr - [X] Pagination - [X] Themes (light, dark, auto) +- [X] Projects page - [X] Analytics using [GoatCounter](https://www.goatcounter.com/) -- [ ] Social Links +- [x] Social Links +- [x] MathJax Rendering +- [x] Meta Tags For Individual Pages - [ ] Search - [ ] Categories @@ -57,7 +60,7 @@ git submodule add https://github.com/not-matthias/apollo themes/apollo 3. Copy the example content ``` -cp themes/apollo/content content +cp -r themes/apollo/content content ``` ## Options @@ -76,8 +79,62 @@ stylesheets = [ These filenames are relative to the root of the site. In this example, the two CSS files would be in the `static` folder. +### MathJax + +To enable MathJax equation rendering, set the variable `mathjax` to `true` in +the `extra` section of your config.toml. Set `mathjax_dollar_inline_enable` to +`true` to render inline math by surrounding them inside $..$. + +```toml +[extra] +mathjax = true +mathjax_dollar_inline_enable = true +``` + +## Config + + ### Customize `` tags + + The following TOML and YAML code will yiled two `` tags, ``, ``. + + TOML: + + ```toml + title = "post title" + description = "post desc" + date = "2023-01-01" + + [extra] + meta = [ + {property = "og:title", content = "the og title"}, + {property = "og:description", content = "the og description"}, + ] + ``` + + YAML: + + ```yaml + title: "post title" + description: "post desc" + date: "2023-01-01" + extra: + meta: + - property: "og:title" + content: "the og title" + - property: "og:description" + content: "the og description" + ``` + + If the `og:title`, the `og:description`, or the "description" are not set, the page's title and description will be used. That is, the following TOML code generates ``, ``, and `` as default values. + + ```toml + title = "post title" + description = "post desc" + date = "2023-01-01" + ``` + ## References -This theme is based on [archie-zola](https://github.com/XXXMrG/archie-zola/). +This theme is based on [archie-zola](https://github.com/XXXMrG/archie-zola/). \ No newline at end of file diff --git a/docs/content/themes/archie-zola/index.md b/docs/content/themes/archie-zola/index.md index 405dd22826..aeeb441345 100644 --- a/docs/content/themes/archie-zola/index.md +++ b/docs/content/themes/archie-zola/index.md @@ -3,11 +3,11 @@ title = "archie-zola" description = "A zola theme based on Hugo archie." template = "theme.html" -date = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/XXXMrG/archie-zola.git" homepage = "https://github.com/XXXMrG/archie-zola" minimum_version = "0.14.0" @@ -64,6 +64,7 @@ theme = "archie-zola" * Auto Dark Mode(based on system theme) * Dark/Light Mode toggle * Google Analytics Script +* Meta Tags For Individual Pages in the planning stage： @@ -73,6 +74,45 @@ in the planning stage： ## Config +### Customize `` tags + +The following TOML and YAML code will yiled two `` tags, ``, ``. + +TOML: + +```toml +title = "post title" +description = "post desc" +date = "2023-01-01" + +[extra] +meta = [ + {property = "og:title", content = "the og title"}, + {property = "og:description", content = "the og description"}, +] +``` + +YAML: + +```yaml +title: "post title" +description: "post desc" +date: "2023-01-01" +extra: + meta: + - property: "og:title" + content: "the og title" + - property: "og:description" + content: "the og description" +``` + +If the `og:title`, the `og:description`, or the "description" are not set, the page's title and description will be used. That is, the following TOML code generates ``, ``, and `` as default values. + +```toml +title = "post title" +description = "post desc" +date = "2023-01-01" +``` ### Theme config @@ -165,4 +205,5 @@ We appreciate any form of contribution: * New issues (feature requests, bug reports, questions, ideas, ...) * Pull requests (documentation improvements, code improvements, new features, ...) + \ No newline at end of file diff --git a/docs/content/themes/ataraxia-zola/index.md b/docs/content/themes/ataraxia-zola/index.md index 79cef87016..6ed2e251ee 100644 --- a/docs/content/themes/ataraxia-zola/index.md +++ b/docs/content/themes/ataraxia-zola/index.md @@ -1,27 +1,27 @@ +++ title = "ataraxia" -description = "A personal theme focused on ease of reading" +description = "A personal theme focused on ease of reading." template = "theme.html" -date = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/gersonbdev/ataraxia-zola" -homepage = "https://github.com/gersonbdev/ataraxia-zola" +homepage = "https://github.com/gersonbenavides/ataraxia-zola" minimum_version = "0.16.0" license = "MPL-2.0" -demo = "https://gersonbdev.github.io/" +demo = "https://www.gersonb.dev/" [extra.author] name = "Gerson Benavides" -homepage = "https://gersonbdev.github.io/" +homepage = "https://github.com/gersonbenavides/ataraxia-zola" +++ # Ataraxia -[![Ataraxia preview](https://raw.githubusercontent.com/gersonbdev/ataraxia-zola/main/mockup.png "Ataraxia mockup")](https://gersonbdev.github.io/) +[![Ataraxia preview](https://raw.githubusercontent.com/gersonbenavides/ataraxia-zola/main/mockup.png "Ataraxia mockup")](https://gersonbenavides.github.io/) A personal theme for [Zola](https://www.getzola.org/) focused on readability that aims to be simple, beautiful, and modern. It is designed to support multiple languages and be highly customizable. @@ -31,19 +31,19 @@ The theme takes visual inspiration from the [Chirpy](https://github.com/cotes202 Open a command terminal at your site path and run: -```console +```bash cd themes ``` -```console -git clone https://github.com/gersonbdev/ataraxia-zola.git +```bash +git clone https://github.com/gersonbenavides/ataraxia-zola.git ataraxia ``` ## Configuration Copy the `config_sample.toml` file to your site's main path, then rename it to `config.toml` and edit it with your site data. -> You can see the [Gerson's website](https://github.com/gersonbdev/gersonbdev.github.io) repository for theme setup guide. +> You can see the [Gerson's website](https://github.com/gersonbenavides/gersonbenavides.github.io) repository for theme setup guide. For the site to work properly you need to create a `_index.md` file within the `content` path with the following structure: @@ -74,7 +74,7 @@ page_template = "blog_page.html" You can display the result of your website by running: -```console +```bash zola serve ``` @@ -85,11 +85,11 @@ By default, the theme comes with all the scss styles already compiled, in such a If you want to edit the theme's styles, you'll need to have a [Node.js](https://nodejs.org/) interpreter and a [Sass compiler](https://sass-lang.com/install) installed. After that, go to the main path of the theme and execute: -```console +```bash npm install ``` -```console +```bash sass --watch scss/custom.scss:static/assets/css/custom.css ``` @@ -101,7 +101,10 @@ This theme is mainly built on [Zola](https://www.getzola.org/) and [Bootstrap](h ## Sponsoring -[![Liberapay](https://img.shields.io/badge/Finance%20the%20project-F6C915?style=flat&logo=liberapay&logoColor=ffffff "Finance the project")](https://liberapay.com/gersonbenavides/donate) + +[![Liberapay](https://img.shields.io/badge/Finance%20my%20work-F6C915?style=flat&logo=liberapay&logoColor=ffffff "Finance my work")](https://liberapay.com/gersonbenavides/donate) + +[![PayPal](https://img.shields.io/badge/Make%20a%20donation-00457C?style=flat&logo=paypal "Make a donation")](https://paypal.me/gersonbdev?country.x=CO&locale.x=es_XC) ## License diff --git a/docs/content/themes/bearblog/index.md b/docs/content/themes/bearblog/index.md new file mode 100644 index 0000000000..4292015229 --- /dev/null +++ b/docs/content/themes/bearblog/index.md @@ -0,0 +1,103 @@ + ++++ +title = "Bear" +description = "Bear blog theme" +template = "theme.html" +date = 2023-04-30T21:01:54+02:00 + +[extra] +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 +repository = "https://codeberg.org/alanpearce/zola-bearblog" +homepage = "https://codeberg.org/alanpearce/zola/bearblog" +minimum_version = "0.4.0" +license = "MIT" +demo = "https://alanpearce.codeberg.page/zola-bearblog" + +[extra.author] +name = "Alan Pearce" +homepage = "https://alanpearce.eu" ++++ + +# Zola ʕ•ᴥ•ʔ Bear Blog + +🧸 A [Zola](https://www.getzola.org/)-theme based on [Bear Blog](https://bearblog.dev). + +> Free, no-nonsense, super-fast blogging. + +## Demo + +For a current & working demo of this theme, please check out https://alanpearce.codeberg.page/zola-bearblog/ 🎯. + +## Screenshots + +⬜️ [Light][light-screenshot] +![light mode screenshot][light-screenshot] + +⬛️ [Dark][dark-screenshot] +![dark mode screenshot][dark-screenshot] + +When the user's browser is running »dark mode«, the dark color scheme will be used automatically. The default is the light/white color scheme. Check out the [`style.html`](https://codeberg.org/alanpearce/zola-bearblog/src/branch/main/templates/style.html)-file for the implementation. + +## Installation + +If you already have a Zola site on your machine, you can simply add this theme via + +``` +git submodule add https://codeberg.org/alanpearce/zola-bearblog themes/zola-bearblog +``` + +Then, adjust the `config.toml` as detailed below. + +For more information, read the official [setup guide][zola-setup-guide] of Zola. + +## Adjust configuration / config.toml + +Please check out the included [config.toml](https://codeberg.org/alanpearce/zola-bearblog/src/branch/main/config.toml) + +## Content & structure + +### Menu + +Create an array in `extra` with a key of `main_menu`. `url` is passed to [`get_url`](https://www.getzola.org/documentation/templates/overview/#get-url) + +```toml +[[extra.main_menu]] +name = "Bear" +url = "@/bear.md" + +[[extra.main_menu]] +name = "Zola" +url = "@/zola.md" + +[[extra.main_menu]] +name = "Blog" +url = "@/blog/_index.md" +``` + +### Adding / editing content + +#### Index-Page + +The contents of the `index`-page may be changed by editing your `content/_index.md`-file. + + +### Adding your branding / colors / css + +Add a `custom_head.html`-file to your `templates/`-directory. In there you may add a ` -``` +See the default value [here](./templates/_variables.html) ### Favicon +The same way as changing the `hero` block in the `templates/index.html`, you can change the **favicon**. ```html {%/* extends "juice/templates/index.html" */%} @@ -115,6 +100,17 @@ You can override theme variable by creating a file named `_variables.html` in yo {%/* endblock favicon */%} ``` +### Fonts +If you changed the `--xy-font-family`-variable in `_variables.html`, you have to load the mentioned fonts in the `templates/index.html`. + +```html +{%/* extends "juice/templates/index.html" */%} +{%/* block fonts */%} + + +{%/* endblock fonts */%} +``` + # Configuration You can customize some builtin property in `config.toml` file: @@ -126,6 +122,9 @@ juice_logo_path = "juice.svg" juice_extra_menu = [ { title = "Github", link = "https://github.com/huhu/juice"} ] +juice_exclude_menu = [ + "exclude_from_nav" +] repository_url = "https://github.com/huhu/juice" ``` @@ -134,7 +133,7 @@ repository_url = "https://github.com/huhu/juice" **Juice** have some builtin shortcodes available in `templates/shortcodes` directory. - `issue(id)` - A shortcode to render issue url, e.g. `issue(id=1)` would render to the link `https://github.com/huhu/juice/issue/1`. - + > The `repository_url` is required. # Showcases @@ -149,5 +148,4 @@ We appreciate any form of contribution: - New issues (feature requests, bug reports, questions, ideas, ...) - Pull requests (documentation improvements, code improvements, new features, ...) - \ No newline at end of file diff --git a/docs/content/themes/kangae/index.md b/docs/content/themes/kangae/index.md index 766d4f98f8..802b696412 100644 --- a/docs/content/themes/kangae/index.md +++ b/docs/content/themes/kangae/index.md @@ -3,16 +3,16 @@ title = "kangae" description = "a lightweight microblog theme for zola" template = "theme.html" -date = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/ayushnix/kangae.git" homepage = "https://github.com/ayushnix/kangae" minimum_version = "0.15.0" license = "NCSA" -demo = "" +demo = "https://kangae.ayushnix.com/" [extra.author] name = "Ayush Agarwal" diff --git a/docs/content/themes/karzok/index.md b/docs/content/themes/karzok/index.md index 9c50ac02f7..45b026a384 100644 --- a/docs/content/themes/karzok/index.md +++ b/docs/content/themes/karzok/index.md @@ -3,11 +3,11 @@ title = "karzok" description = "The theme for launching fast documentation sites" template = "theme.html" -date = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/kogeletey/karzok.git" homepage = "https://github.com/kogeletey/karzok" minimum_version = "0.15.0" @@ -38,20 +38,13 @@ A theme for your documentation. Fast and secure ## Requirements -Karzok uses npm,zola to dependency managment,rendering, scripts and plugins. - -### Install - -1. [Zola](https://www.getzola.org/documentation/getting-started/installation/) -2. [Node.js](https://nodejs.org/) -3. [rsync](https://rsync.samba.org) - -for your platform. +- [Node.js](https://nodejs.org/) ### Optional - [docker](https://docs.docker.com/engine/install/) - > for packaging container and production + +> for packaging container and production ## Get Started @@ -163,19 +156,11 @@ will. Specifically you can redistribute and/or modify it under the terms of the # Contribute -Make sure to read the [Code of Conduct](https://karzok.re128.org/reference/code-of-conduct/) +Make sure to read the [Code of Conduct](https://karzok.re128.org/reference/code_of_conduct/) ## Find bugs and come up with features On the [todo.sr.ht](https://todo.sr.ht/~kogeletey/karzok) or [github issues](https://github.com/kogeletey/karzok/issues) -## Improve Code - -The karzok is stored in the repository at -[sr.ht](https://sr.ht/~kogeletey/karzok) and mirror -[github](https://github.com/kogeletey/karzok) - -> Thank you so much for any help - \ No newline at end of file diff --git a/docs/content/themes/kodama-theme/index.md b/docs/content/themes/kodama-theme/index.md index f2f4860bf4..e7b0124ac2 100644 --- a/docs/content/themes/kodama-theme/index.md +++ b/docs/content/themes/kodama-theme/index.md @@ -3,11 +3,11 @@ title = "kodama" description = "Theme insipired by wowchemy academic." template = "theme.html" -date = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/adfaure/kodama-theme.git" homepage = "https://github.com/adfaure/kodama-theme" minimum_version = "0.15" @@ -260,6 +260,23 @@ slides = "path_to_slides.pdf" +++ ``` +## Extend the html header + +In some cases, it is needed to add extra javascript or css files to be loaded by the web browsers. +The base template of this theme define an empty block named `user_head`. + +To use this block, you can just create a new template name `templates/base.html` with the following content: + +```html +{%/* extends "kodama-theme/templates/base.html" */%} + +{%/* block user_head */%} + +{%/* endblock user_head */%} +``` + ## Icons The icons available in this project are stored in a dedicated macro function in `templates/macros/icons.html`. diff --git a/docs/content/themes/lightspeed/index.md b/docs/content/themes/lightspeed/index.md index 9b33f004b0..9f82b34055 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 = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/carpetscheme/lightspeed.git" homepage = "https://github.com/carpetscheme/lightspeed" minimum_version = "0.10.0" diff --git a/docs/content/themes/nasm-theme/index.md b/docs/content/themes/nasm-theme/index.md index 7cdfcd340c..11ece346fc 100644 --- a/docs/content/themes/nasm-theme/index.md +++ b/docs/content/themes/nasm-theme/index.md @@ -3,11 +3,11 @@ title = "nasm-theme" description = "A robust, elegant blue theme" template = "theme.html" -date = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/lucasnasm/nasm-theme.git" homepage = "https://github.com/lucasnasm/nasm-theme" minimum_version = "0.1.0" diff --git a/docs/content/themes/no-style-please/index.md b/docs/content/themes/no-style-please/index.md index af5b6bc040..1a45eeec64 100644 --- a/docs/content/themes/no-style-please/index.md +++ b/docs/content/themes/no-style-please/index.md @@ -3,11 +3,11 @@ title = "no style, please!" description = "A (nearly) no-CSS, fast, minimalist Zola theme" template = "theme.html" -date = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://gitlab.com/4bcx/no-style-please.git" homepage = "https://gitlab.com/4bcx/no-style-please" minimum_version = "0.4.0" @@ -43,13 +43,56 @@ theme = "no-style-please" ## Options +### Default taxonomies + +Special templates for `tags`, `categories`, and `contexts` taxonomies are provided. However, generic templates exist for custom taxonomies. + +To use taxonomies, in a page metadata add + +```toml +[taxonomies] +tags = [ 'tag1', 'tag2' ] +categories = [ 'category A', 'B class' ] +genre = [ 'rock', 'alternative' ] # custom taxonomy +``` + ### Pages list in homepage -To enable listing of pages in homepage add the following in `content\_index.md` frontmatter +To enable listing of pages in homepage add the following in `config.toml` + +```toml +[extra] +list_pages = true +``` + +### Header and footer nav links + +Also in the `extra` section in `config.toml` + +```toml +[extra] + +header_nav = [ + { name = "~home", url = "/" }, + { name = "#tags", url = "/tags" }, + { name = "+categories", url = "/categories" }, + { name = "@contexts", url = "/contexts" }, + { name = "example", url = "http://example.com", new_tab=true }, +] +footer_nav = [ + { name = "< previous", url = "#" }, + { name = "webring", url = "#" }, + { name = "next >", url = "#" }, +] +``` + +### Add TOC to pages + +In a page frontmatter, set `extra.add_toc` to `true` ```toml -[exta] -list_pages = false +[extra] +add_toc = true ``` ### Extra data @@ -86,6 +129,15 @@ In dark mode ![image in dark mode](./iimg_dark.png) +### Disable Twitter card + +Twitter metatags are generated by default, to disable them set `extra.twitter_card` to `false` in in your `config.toml` + +```toml +[extra] +twitter_card = true +``` + ## TODO - [ ] Add RTL support diff --git a/docs/content/themes/ntun/index.md b/docs/content/themes/ntun/index.md index 854500aeb1..c6a310d495 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 = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/Netoun/ntun.git" 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 df64bb3634..0c04032cdd 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 = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02: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 b6952a9e3a..09eac3470e 100644 --- a/docs/content/themes/papaya/index.md +++ b/docs/content/themes/papaya/index.md @@ -3,14 +3,14 @@ title = "Papaya" description = "A clean Zola theme for blogging and projects" template = "theme.html" -date = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/justint/papaya.git" homepage = "https://github.com/justint/papaya" -minimum_version = "0.14.0" +minimum_version = "0.16.1" license = "MIT" demo = "https://justintennant.me/papaya" @@ -23,26 +23,38 @@ homepage = "https://justintennant.me" A clean [Zola](https://getzola.org) theme for blogging and projects, forked from [Anpu](https://github.com/zbrox/anpu-zola-theme). +## Preview + **Demo site**: [https://justintennant.me/papaya/](https://justintennant.me/papaya/) -![index](pics/index.png) +![index light/dark](https://raw.githubusercontent.com/justint/papaya/main/pics/blendedindex.png) -![projects](pics/projects.png) +

+ Light Projects +        + Dark Projects +

-![project](pics/project.png) +

+ Light Project +        + Dark Project +

## Features - Blog posts - Project pages +- Automatic light/dark mode - Categories and tags -- Multilingual support +- Optional multilingual support - Customizable sections and navigation menu links - Featured images for posts/pages - Smart image embedding shortcode (`{{/* img() */}}`) - GitHub repository star/fork counts - [Open Graph Protocol](https://ogp.me/) tags -- Social/contact links +- [Utterances](https://utteranc.es/) support +- Social/contact links - 100% Google Lighthouse score ## Installation @@ -59,14 +71,13 @@ A clean [Zola](https://getzola.org) theme for blogging and projects, forked from theme = "papaya" ``` -3. This theme requires both the `tags` and `categories` taxonomies. +3. Copy the following sections and keys (and their contents/values) from papaya's [`config.toml`](https://github.com/justint/papaya/blob/main/config.toml) and paste them into your site's `config.toml`: - ```toml - taxonomies = [ - { name = "categories" }, - { name = "tags" }, - ] - ``` + - `[languages]` + - `[languages.en]` + - `[languages.en.translations]` + - `[extra.cdn]` + - `font_awesome` 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`. @@ -97,11 +108,13 @@ A clean [Zola](https://getzola.org) theme for blogging and projects, forked from Here are the customizable features of Papaya: - Project categories +- Light/dark mode - Multilingual support -- Custom sections and navigation menu links +- Sections and navigation menu links - Post/project date formats - Post/project featured images - Open Graph Protocol locale/profile information +- Utterances - Social/contact links ### Project categories @@ -142,9 +155,15 @@ categories = ["software"] The example project page above would be grouped into & displayed within the "Software" category of your projects page. +### Light/dark mode + +The Papaya theme can be set to `"light"`, `"dark"`, or `"auto"` mode in the `config.toml`. + +In `"auto"`, the light and dark modes are implicitly chosen by the `prefers-color-scheme` CSS media feature. The theme will switch automatically based on the viewer's OS or user agent setting. + ### Multilingual support -Currently Zola has a basic internationalization (i18n) support, you can see this at [zola doc](https://www.getzola.org/documentation/content/multilingual/). +Currently Zola has basic internationalization (`i18n`) support, you can read more in [zola's Multilingual Sites doc](https://www.getzola.org/documentation/content/multilingual/). To write a multilingual site, follow the steps below (English and Chinese in this example): @@ -215,7 +234,7 @@ Now you will have a website that supports both English and Chinese! Since `defau 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 +### Sections and navigation menu links The navigation menu is constructed from a list of `menu_items` in your `config.toml`. For example: ```toml @@ -419,6 +438,24 @@ gender = "female" username = "tiliquasp" ``` +### Utterances + +[Utterances](https://utteranc.es/) is a comments widget built on GitHub issues. When enabled, Papaya can display GitHub issues as comments on your blog posts. + +To enable: + +1. Follow instructions on the [utterances](https://utteranc.es/) website. + +2. Once you're at the "Enable Utterances" step, enter the following keys into your `config.toml`: + + ```toml + [extra.utterances] + enabled = true + repo = "yourname/yourrepository" # put your repository's short path here + post_map = "pathname" + label = "utterances" + theme = "preferred-color-scheme" + ### Social/contact links In your `config.toml` you can add a `[extra.social]` section to specify your social network/contact accounts. Changing these will update what links appear on your website's footer. diff --git a/docs/content/themes/particle/index.md b/docs/content/themes/particle/index.md index f1d61b994d..04ac6fad30 100644 --- a/docs/content/themes/particle/index.md +++ b/docs/content/themes/particle/index.md @@ -3,11 +3,11 @@ title = "particle" description = "Particle theme for Zola" template = "theme.html" -date = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/svavs/particle-zola.git" homepage = "https://github.com/svavs/particle" minimum_version = "0.11.0" @@ -40,24 +40,24 @@ The Theme features: 1. [Install Zola](https://getzola.com) 2. Clone the particle theme: `git clone https://github.com/svavs/particle-zola.git` -3. Edit `config.yml` to personalize your site. +3. Edit `config.toml` to personalize your site. ## Site and User Settings -You have to fill some informations on the `[extra]` section of the `config.yml` to customize your site. +You have to fill some informations on the `[extra]` section of the `config.toml` to customize your site. ``` # Site settings -description: A blog about lorem ipsum dolor sit amet +description = "A blog about lorem ipsum dolor sit amet" # User settings -username: Lorem Ipsum -user_description: Anon Developer at Lorem Ipsum Dolor -user_title: Anon Developer -email: my@email.com -twitter_username: lorem_ipsum -github_username: lorem_ipsum -gplus_username: lorem_ipsum +username = "Lorem Ipsum" +user_description = "Anon Developer at Lorem Ipsum Dolor" +user_title = "Anon Developer" +email = "my@email.com" +twitter_username = "lorem_ipsum" +github_username = "lorem_ipsum" +gplus_username = "lorem_ipsum" ``` ## Color and Particle Customization diff --git a/docs/content/themes/resume/index.md b/docs/content/themes/resume/index.md index 358c5c4608..6ef105b933 100644 --- a/docs/content/themes/resume/index.md +++ b/docs/content/themes/resume/index.md @@ -3,11 +3,11 @@ title = "resume" description = "A resume theme" template = "theme.html" -date = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/AlongWY/zola-resume.git" homepage = "https://github.com/alongwy/zola-resume" minimum_version = "0.11.0" diff --git a/docs/content/themes/sam/index.md b/docs/content/themes/sam/index.md index 3a9b81fc39..4e7dac8a2b 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 = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+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/seje2/index.md b/docs/content/themes/seje2/index.md index 4e36f4aba9..aa98922b46 100644 --- a/docs/content/themes/seje2/index.md +++ b/docs/content/themes/seje2/index.md @@ -3,11 +3,11 @@ title = "Seje2" description = "A beautiful zola theme" template = "theme.html" -date = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/eatradish/seje2" homepage = "https://github.com/eatradish/Seje2" minimum_version = "0.15.0" @@ -24,13 +24,7 @@ homepage = "https://blog.utopiosphere.net" ![screenshot](screenshot.png) [Demo](https://eatradish.github.io/Seje2) - -## Contents - -- Installation -- Options - - Top menu - - "About" page +[中文 README](https://github.com/eatradish/Seje2/blob/main/README_zh_cn.md) ## Installation First download this theme to your `themes` directory: @@ -53,6 +47,17 @@ paginate_by = 5 The posts should therefore be in directly under the `content` folder. +and requires your index section (`about/_index.md`) to be paginated to work: + +```toml +title = "..." + +[extra] +year = 2019 +month = 11 +day = 3 +``` + ## Options ### Top-menu @@ -70,17 +75,12 @@ seje2_menu_links = [ If you put `$BASE_URL` in a url, it will automatically be replaced by the actual site URL. -### "About"-page +### License -In a about page (wrap this in +++): +Set a field in `extra` with a key of `license`: ```toml -title = "..." - -[extra] -year = 2019 -month = 11 -day = 03 +license = "@ 宇宙眼睛人" ``` \ No newline at end of file diff --git a/docs/content/themes/serene/index.md b/docs/content/themes/serene/index.md index 900b8ff783..f011e20a03 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 = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/isunjn/serene.git" homepage = "https://github.com/isunjn/serene" minimum_version = "0.9.0" diff --git a/docs/content/themes/shadharon/index.md b/docs/content/themes/shadharon/index.md index d2409c5ba8..f39c3d68d8 100644 --- a/docs/content/themes/shadharon/index.md +++ b/docs/content/themes/shadharon/index.md @@ -3,11 +3,11 @@ title = "shadharon" description = "Simple blog theme powered by Zola" template = "theme.html" -date = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/syedzayyan/shadharon" homepage = "https://github.com/syedzayyan/shadharon" minimum_version = "0.4.0" @@ -60,17 +60,30 @@ git submodule add https://github.com/syedzayyan/shadharon themes/shadharon ``` cp -R themes/shadharon/content/. content ``` -4. For customization refer to config.toml files, which has comments. -5. For customizing the banner on the homepage the content/posts/_index.md needs modification. The desc variable under `extra`, specifically. You could delete this as well to remove banner. For an about page or any aditional page an .md file in the "content" directory will do. +## Customization + +1. For customization refer to config.toml files, which has comments. + +2. For customizing the banner on the homepage the content/posts/_index.md needs modification. The desc variable under `extra`, specifically. You could delete this as well to remove banner. For an about page or any aditional page an .md file in the "content" directory will do. + +You can add stylesheets to override the theme: + +```toml +[extra] +stylesheets = [ + "override.css", +] +``` -## Options These filenames are relative to the root of the site. In this example, the two CSS files would be in the `static` folder. + ## References -This theme is takes inspiration from +This theme takes inspiration from - [apollo](https://github.com/not-matthias/apollo). - [Tania's Website](https://tania.dev/) - [Anpu Zola Theme](https://github.com/zbrox/anpu-zola-theme) + \ 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 048ac85be5..c7ac486525 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 = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/bennetthardwick/simple-dev-blog-zola-starter.git" 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 9f4fac4f49..d608c1b307 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 = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/jameshclrk/zola-slim.git" homepage = "https://github.com/jameshclrk/zola-slim" minimum_version = "0.8.0" diff --git a/docs/content/themes/soapstone/index.md b/docs/content/themes/soapstone/index.md index 57f9792b21..d5a857d981 100644 --- a/docs/content/themes/soapstone/index.md +++ b/docs/content/themes/soapstone/index.md @@ -3,11 +3,11 @@ title = "Soapstone" description = "A bare bones dark theme with some color tweakability" template = "theme.html" -date = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/MattyRad/soapstone.git" homepage = "https://github.com/MattyRad/soapstone" minimum_version = "0.4.0" diff --git a/docs/content/themes/solar-theme-zola/index.md b/docs/content/themes/solar-theme-zola/index.md index 07412a7d31..83e8fd3bd2 100644 --- a/docs/content/themes/solar-theme-zola/index.md +++ b/docs/content/themes/solar-theme-zola/index.md @@ -3,16 +3,16 @@ title = "solar-theme-zola" description = "A port of solar-theme-hugo for zola" template = "theme.html" -date = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+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 = "" +demo = "https://zola-themes-demos.github.io/solar/" [extra.author] name = "hulufei" diff --git a/docs/content/themes/tabi/index.md b/docs/content/themes/tabi/index.md index 88c534b905..7f5a4e59f6 100644 --- a/docs/content/themes/tabi/index.md +++ b/docs/content/themes/tabi/index.md @@ -3,11 +3,11 @@ title = "tabi" description = "A fast, lightweight, and modern Zola theme with optional JavaScript, and a perfect Lighthouse score." template = "theme.html" -date = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/welpo/tabi.git" homepage = "https://github.com/welpo/tabi" minimum_version = "0.9.0" diff --git a/docs/content/themes/tale-zola/index.md b/docs/content/themes/tale-zola/index.md index 5cf866b09a..a5f13a676a 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 = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/aaranxu/tale-zola.git" homepage = "https://github.com/aaranxu/tale-zola" minimum_version = "0.13.0" diff --git a/docs/content/themes/tilde/index.md b/docs/content/themes/tilde/index.md new file mode 100644 index 0000000000..1f7d9d95d4 --- /dev/null +++ b/docs/content/themes/tilde/index.md @@ -0,0 +1,63 @@ + ++++ +title = "tilde" +description = "Simple theme to match the dracula tilde css" +template = "theme.html" +date = 2023-04-30T21:01:54+02:00 + +[extra] +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 +repository = "https://git.sr.ht/~savoy/tilde" +homepage = "https://git.sr.ht/~savoy/tilde" +minimum_version = "0.4.0" +license = "GPLv3" +demo = "https://savoy.srht.site/blog-demo" + +[extra.author] +name = "savoy" +homepage = "https://tilde.team/~savoy/" ++++ + +# tilde + +Lightweight and minimal blog theme for the [Zola](https://www.getzola.org/) +static site generator. + +Live demo is available here: +[https://savoy.srht.site/blog-demo](https://savoy.srht.site/blog-demo) + +![](screen_index.png) + +![](screen_post.png) + +## Installation + +[Theme documentation](https://www.getzola.org/documentation/themes/installing-and-using-themes/) + +Clone this repository into your site's `themes` directory or add it as a +submodule: + +```bash +# Clone into themes +$ git clone https://git.sr.ht/~savoy/tilde themes/tilde +# Add as a submodule +$ git submodule add https://git.sr.ht/~savoy/tilde themes/tilde +``` + +## Configuration + +This theme offers the following config options: + +```toml +[extra] + +homepage = "" # author homepage +subtitle = "" # blog subtitle +git_source = "" # blog source code +author = "" # author name +email = "" # author email +license = "" # blog license +``` + + \ No newline at end of file diff --git a/docs/content/themes/tilde/screenshot.png b/docs/content/themes/tilde/screenshot.png new file mode 100644 index 0000000000..88dccc545b Binary files /dev/null and b/docs/content/themes/tilde/screenshot.png differ diff --git a/docs/content/themes/toucan/index.md b/docs/content/themes/toucan/index.md index 86c0db4a44..6c5c167b92 100644 --- a/docs/content/themes/toucan/index.md +++ b/docs/content/themes/toucan/index.md @@ -3,16 +3,16 @@ title = "Toucan" description = "Inspired from Pelican default theme" template = "theme.html" -date = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://git.42l.fr/HugoTrentesaux/toucan.git" homepage = "https://git.42l.fr/HugoTrentesaux/toucan" minimum_version = "0.8.0" license = "AGPL" -demo = "http://blog.coinduf.eu/" +demo = "https://toucan.coinduf.eu/" [extra.author] name = "Hugo Trentesaux" diff --git a/docs/content/themes/zerm/index.md b/docs/content/themes/zerm/index.md index a4f64dbc7d..65a93650da 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 = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/ejmg/zerm.git" homepage = "https://github.com/ejmg/zerm" minimum_version = "0.8.0" diff --git a/docs/content/themes/zhuia/index.md b/docs/content/themes/zhuia/index.md index 2852c06fd9..d1b48037aa 100644 --- a/docs/content/themes/zhuia/index.md +++ b/docs/content/themes/zhuia/index.md @@ -3,11 +3,11 @@ title = "Zhuia" description = "An elegant but still playful theme for Zola." template = "theme.html" -date = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/gicrisf/zhuia.git" homepage = "https://github.com/gicrisf/zhuia" minimum_version = "0.15.0" @@ -21,6 +21,8 @@ homepage = "https://github.com/gicrisf" # Zhuia +![logo-zhuia](static/logo.png) + An elegant but still playful theme for [Zola](https://getzola.org/) powered by [Spectre.css](https://picturepan2.github.io/spectre/). It is especially optimized for mobile navigation (optionally without JavaScript, if you don't like fancy stuff). @@ -34,6 +36,7 @@ It is especially optimized for mobile navigation (optionally without JavaScript, - Options - Title - SEO + - Menu - Social - Footer - Name @@ -82,15 +85,16 @@ sort_by = "date" - [x] Easily extendable menu - [ ] Inter-page pagination - [x] Optional NoJs -- [ ] Hamburger animation +- [x] Hamburger animation - [ ] Comments - [ ] Related posts (not sure about this) - [ ] Search bar - [x] Math rendering -- [ ] Other shortcodes (WIP) -- [ ] Multilanguage support (WIP) +- [x] Other shortcodes +- [ ] Multilanguage support - [ ] Dark mode - [ ] Table of Contents +- [ ] Image + text title option ## Options @@ -131,16 +135,18 @@ Set a field in `extra` with a key of `footer_links`: # Freely comment out or delete every field social_links = [ {url = "https://t.me/yourname", name = "telegram"}, - # {url = "https://facebook.com/yourname", name = "facebook"}, - {url = "https://twitter.com/yourname", name = "twitter"}, - # {url = "", name = "instagram"}, + {url = "https://twitter.com/gicrisf", name = "twitter"}, {url = "https://github.com/gicrisf", name = "github"}, + # {url = "", name = "facebook"}, + # {url = "", name = "instagram"}, + # {url = "", name = "bookstack"}, + # {url = "", name = "dokuwiki"}, ] ``` ![social buttons](social-buttons.png) -The theme automatically use the right icons for the social in the example. +The theme automatically picks up the right icons. We can expand the support to other social, for sure: make a PR or open an enhancement issue to ask a new implementation. ### Footer diff --git a/docs/content/themes/zola-paper/index.md b/docs/content/themes/zola-paper/index.md index ffc713026b..bbfd2127c9 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 = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02: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 5f10770b98..8797037d9c 100644 --- a/docs/content/themes/zola-pickles/index.md +++ b/docs/content/themes/zola-pickles/index.md @@ -3,16 +3,16 @@ title = "pickles" description = "A modern, simple, clean blog theme for Zola." template = "theme.html" -date = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/lukehsiao/zola-pickles.git" homepage = "https://github.com/lukehsiao/zola-pickles" minimum_version = "0.13.0" license = "MIT OR Apache-2.0" -demo = "" +demo = "https://effervescent-chebakia-056748.netlify.app/" [extra.author] name = "Luke Hsiao" diff --git a/docs/content/themes/zola-theme-course/index.md b/docs/content/themes/zola-theme-course/index.md index 48e9fe15d5..51c9da5c5e 100644 --- a/docs/content/themes/zola-theme-course/index.md +++ b/docs/content/themes/zola-theme-course/index.md @@ -3,16 +3,16 @@ title = "Course" description = "A zola theme designed for online courses or tutorials" template = "theme.html" -date = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/elegaanz/zola-theme-course.git" homepage = "https://github.com/elegaanz/zola-theme-course" -minimum_version = "0.15.0" +minimum_version = "0.17.1" license = "GPL-3.0" -demo = "https://c.gelez.xyz" +demo = "https://c.gelez.xyz/" [extra.author] name = "Ana Gelez" diff --git a/docs/content/themes/zola-theme-hikari/index.md b/docs/content/themes/zola-theme-hikari/index.md index 918cfdf21e..1294b5f1ac 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 = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/waynee95/zola-theme-hikari.git" homepage = "https://github.com/waynee95/zola-theme-hikari" minimum_version = "0.5.1" diff --git a/docs/content/themes/zola-theme-terminimal/index.md b/docs/content/themes/zola-theme-terminimal/index.md index a3338cf3fb..025607a4a1 100644 --- a/docs/content/themes/zola-theme-terminimal/index.md +++ b/docs/content/themes/zola-theme-terminimal/index.md @@ -3,11 +3,11 @@ title = "terminimal" description = "A simple, minimal retro theme" template = "theme.html" -date = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/pawroman/zola-theme-terminimal.git" homepage = "https://github.com/pawroman/zola-theme-terminimal" minimum_version = "0.11.0" @@ -29,7 +29,7 @@ homepage = "https://github.com/pawroman" See the live demo (of the default configuration) here: https://pawroman.github.io/zola-theme-terminimal/ -Tested with Zola v0.15.3. +Tested with Zola v0.16.1. Please note that earlier versions might not work because of breaking changes across Zola versions. #### Fork disclaimer @@ -147,7 +147,7 @@ Example: ``` {{/* figure(src="http://rustacean.net/assets/rustacean-flat-gesture.png", style="width: 25%;", - position="right" + position="right", caption_position="left", caption="Ferris, the (unofficial) Rust mascot", caption_style="font-weight: bold; font-style: italic;") */}} @@ -343,6 +343,25 @@ favicon = "/favicon.png" favicon_mimetype = "image/png" ``` +### Page titles + +The theme allows you to configure how the page titles (the `` elements) are rendered. + +Use `"combined"` to render titles as `"Page title | Main title"`. + +```toml +# Optional: Set how <title> elements are rendered. +# Values: +# - "main_only" -- only the main title (`config.title`) is rendered. +# - "page_only" -- only the page title (if defined) is rendered, +# falling back to `config.title` if not defined or empty. +# - "combined" -- combine like so: "page_title | main_title", +# or if page_title is not defined or empty, fall back to `main_title` +# +# Note that the main (index) page only has the main title. +page_titles = "combined" +``` + All the configuration options are also described in [`config.toml`](../master/config.toml). diff --git a/docs/content/themes/zola.386/index.md b/docs/content/themes/zola.386/index.md index a88bd2ba29..b893366dc8 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 = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/lopes/zola.386.git" 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 cfffbc2352..8561f340ba 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 = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/codeandmedia/zola_easydocs_theme.git" homepage = "https://github.com/codeandmedia/zola_easydocs_theme" minimum_version = "0.13.0" diff --git a/docs/content/themes/zolastrap/index.md b/docs/content/themes/zolastrap/index.md index a00bb09ba6..e13e59b28d 100644 --- a/docs/content/themes/zolastrap/index.md +++ b/docs/content/themes/zolastrap/index.md @@ -3,11 +3,11 @@ title = "zolastrap" description = "A bootstrap theme for zola" template = "theme.html" -date = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/marcodpt/zolastrap.git" homepage = "https://github.com/marcodpt/zolastrap" minimum_version = "0.14.1" diff --git a/docs/content/themes/zplit/index.md b/docs/content/themes/zplit/index.md index a62c04fcf4..79a6c2c336 100644 --- a/docs/content/themes/zplit/index.md +++ b/docs/content/themes/zplit/index.md @@ -3,11 +3,11 @@ title = "Zplit" description = "A single page theme for a professional online presence." template = "theme.html" -date = 2023-04-16T21:40:29+02:00 +date = 2023-04-30T21:01:54+02:00 [extra] -created = 2023-04-16T21:40:29+02:00 -updated = 2023-04-16T21:40:29+02:00 +created = 2023-04-30T21:01:54+02:00 +updated = 2023-04-30T21:01:54+02:00 repository = "https://github.com/gicrisf/zplit" homepage = "https://github.com/gicrisf/zplit" minimum_version = "0.15.0" @@ -103,7 +103,9 @@ To sort the post index by date, enable sort in your index section `content/_inde sort_by = "date" ``` -Showing the posts in the main page could need some tweaking of the code, because it's not an officially supported feature. +This theme wasn't written with blogging in mind, but more as a landing page for professionals. If you want to blog some stuff, though, you can, absolutely. If you add a new section in the content directory, you just have to add it to the main menu through the config file and it will be immediately accessible to the user. + +The theme doesn't support taxonomies or other advanced stuff: just simple pages. If you want to extend the blogging features, feel free to tweak the code or open an issue with a specific request. ## Custom CSS @@ -146,6 +148,7 @@ If you choose this way, you don't have to care about anything else in that file. - [x] Custom CSS - [x] Custom colors - [x] 404 page +- [x] Basic blogging features - [ ] Open Graph and Twitter Cards support - [ ] Multilanguage support