-
Notifications
You must be signed in to change notification settings - Fork 989
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: GitHub Action <action@github.com>
- Loading branch information
1 parent
0f21270
commit 0113a73
Showing
68 changed files
with
489 additions
and
192 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,156 @@ | ||
|
|
||
| +++ | ||
| 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 | ||
|
|
||
| [extra] | ||
| created = 2023-04-16T21:40:29+02:00 | ||
| updated = 2023-04-16T21:40:29+02:00 | ||
| repository = "https://gitlab.com/cyril-marpaud/hayflow.git" | ||
| homepage = "https://gitlab.com/cyril-marpaud/hayflow" | ||
| minimum_version = "0.4.0" | ||
| license = "CC-BY-SA 4.0" | ||
| demo = "https://cyril-marpaud.gitlab.io" | ||
|
|
||
| [extra.author] | ||
| name = "Cyril Marpaud" | ||
| homepage = "https://cyril-marpaud.gitlab.io" | ||
| +++ | ||
|
|
||
| # HayFlow - Modular Zola Theme | ||
|
|
||
| ## About | ||
|
|
||
| <div align="center"> | ||
|  | ||
| </div> | ||
|
|
||
| [HayFlow](https://gitlab.com/cyril-marpaud/hayflow) is a modular landing page made as a theme for [Zola](https://www.getzola.org), a static site generator written in [Rust](https://www.rust-lang.org). It features a dark theme with a particles background, vertical arrows for navigation and a few card types which you are free to include to best suit your needs. Nearly all UI elements are subtly animated to convey a professional look (although I'm no designer 🤷 merely an [embedded systems engineer](https://www.linkedin.com/in/cyrilmarpaud)). | ||
|
|
||
| It has been designed to require only [Markdown](https://www.markdownguide.org) editing (no HTML/CSS), but feel free to do so if you need to. I'll be glad to review a [Merge Request](https://gitlab.com/cyril-marpaud/hayflow/-/merge_requests) if you implement a new card type ! | ||
|
|
||
| [[_TOC_]] | ||
|
|
||
| ## Live demo | ||
|
|
||
| See [my personal website](https://cyril-marpaud.gitlab.io) for an example of what can be accomplished in a few minutes with this theme. Its source code is also available as an example in my [Gitlab website repository](https://gitlab.com/cyril-marpaud/cyril-marpaud.gitlab.io). | ||
|
|
||
| ## Built with | ||
|
|
||
| - [Zola](https://www.getzola.org) | ||
| - [Particles.js](https://vincentgarreau.com/particles.js/) | ||
| - [Font Awesome](https://fontawesome.com) | ||
| - [Modern Normalize](https://github.com/sindresorhus/modern-normalize) | ||
| - Inspiration came from [particle-zola](https://github.com/svavs/particle-zola), another theme. | ||
|
|
||
| ## Quick start | ||
|
|
||
| Initialize a Zola website and install HayFlow: | ||
| ```bash | ||
| zola init mywebsite | ||
| 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/)). | ||
|
|
||
| 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). | ||
|
|
||
| ## 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). | ||
|
|
||
| - `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`. | ||
|
|
||
| ```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" }, | ||
| ] | ||
| ``` | ||
|
|
||
| ## Adding a section | ||
|
|
||
| Inside the `content` directory, create a `pizza` folder and place this `_index.md` file inside: | ||
|
|
||
| ```TOML | ||
| +++ | ||
| title = "Pizza" | ||
| +++ | ||
|
|
||
| What a mouthful ! | ||
| ``` | ||
|
|
||
| Then, add this `sections` variable (an array of strings) to your `config.toml`'s `[extra]` section: | ||
|
|
||
| ```TOML | ||
| [extra] | ||
| sections = ["pizza"] | ||
| ``` | ||
|
|
||
| A new internal link pointing to that section will appear on the landing page. Click it and see what happens ! This is called a "simple card" section. | ||
|
|
||
| ## 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: | ||
|
|
||
| ```TOML | ||
| +++ | ||
| title = "Pizza" | ||
|
|
||
| [extra] | ||
| card_type = "simple" | ||
| +++ | ||
|
|
||
| What a mouthful ! | ||
| ``` | ||
|
|
||
| ### Columns card | ||
|
|
||
| Add a new section and set its card type to `columns`. Then, alongside the `_index.md` file, create three other files: `one.md`, `two.md` and `three.md`. These will be the ingredients of your new pizza. Their content is similar to `_index.md`: | ||
|
|
||
| ```TOML | ||
| +++ | ||
| title = "Tomato" | ||
|
|
||
| [extra] | ||
| icons = ["fa-solid fa-tomato"] | ||
| +++ | ||
|
|
||
| The basis of any self-respecting pizza. It is the edible berry of the plant Solanum lycopersicum. | ||
| ``` | ||
|
|
||
| The `icons` variable is optional. | ||
|
|
||
| ### List card | ||
|
|
||
| Add a new section and set its card type to `list`. Then, alongside the `_index.md` file, create three other files: `one.md`, `two.md` and `three.md`. These will be your favourite pizzas. Their content is similar to `_index.md`: | ||
|
|
||
| ```TOML | ||
| +++ | ||
| title = "Margherita" | ||
|
|
||
| [extra] | ||
| link = "https://en.wikipedia.org/wiki/Pizza_Margherita" | ||
| +++ | ||
|
|
||
| Margherita pizza is a typical [Neapolitan pizza](https://en.wikipedia.org/wiki/Neapolitan_pizza), made with San Marzano tomatoes, mozzarella cheese, fresh basil, salt, and extra-virgin olive oil. | ||
| ``` | ||
|
|
||
| The `link` variable is optional. | ||
|
|
||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.