not-matthias / apollo

Modern and minimalistic blog theme.
https://not-matthias.github.io/apollo
MIT License
137 stars 80 forks source link

added a homepage! #62

Closed SeniorMars closed 5 months ago

SeniorMars commented 5 months ago

fixes #59

Now, I decided to use the template method, as people may want to use this template more than once. So I provided a new macro and template.

Here is an example:

+++
title= "Welcome to Apollo's Homepage!"
template = "homepage.html"
+++

# apollo

Modern and minimalistic blog theme powered by [Zola](https://getzola.org). See a live preview [here](https://not-matthias.github.io/apollo).

<sub><sup>Named after the greek god of knowledge, wisdom and intellect</sup></sub>

## Features

- [X] Pagination
- [X] Themes (light, dark, auto)
- [X] Projects page
- [X] Analytics using [GoatCounter](https://www.goatcounter.com/) / [Umami](https://umami.is/)
- [x] Social Links
- [x] MathJax Rendering
- [x] Taxonomies
- [x] Meta Tags For Individual Pages
- [ ] Search
- [ ] Categories

## Installation

1. Download the theme

git submodule add https://github.com/not-matthias/apollo themes/apollo


2. Add `theme = "apollo"` to your `config.toml`
3. Copy the example content

cp -r themes/apollo/content content


## Options
### 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 <meta/> tags

The following TOML and YAML code will yiled two <meta/> tags, <meta property="og:title" content="the og title"/>, <meta property="og:description" content="the og description"/>.

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:

 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 <meta property="og:title" content="post title"/>, <meta property="og:description" content="post desc"/>, and <meta property="og:description" content="post desc"/> as default values.

 title = "post title"
 description = "post desc"
 date = "2023-01-01"

References

This theme is based on archie-zola.

CleanShot 2024-06-21 at 21 56 35@2x CleanShot 2024-06-21 at 21 56 44@2x

Maybe we should consider using the readme as the home page. It looks pretty good. I would prefer this as a default.

not-matthias commented 5 months ago

Maybe we should consider using the readme as the home page. It looks pretty good. I would prefer this as a default. Yeah, that seems like a good idea. I think it's also a good idea to properly document all the options in that case. That's been on my backlog for a long time, I'll also create an issue for that.

Thanks for the homepage :)