elixir-griffin / griffin Goto Github PK

I'm trying to make a site where there's a home page that is a list of posts and then the show page for the individual posts. From reading through the docs I assumed it would look like

  collections: %{
    posts: %{
      permalink: "/",
      list_layout: "home",
      show_layout: "show"
    }
  }

but then in the home.html.eex layout there is no @collection_values assigns. I might be missing something obvious here but so far I'm just confused.

Originally reported in #12.
Users should be able to set permalinks for their collections. Previously we were assuming the collection name would be the "permalink", but a typical use case would be to display a collection in the home page.

Currently we only support a global data folder that is read before parsing content files.

Let's assume that a Griffin project has the following simplified structure

.
├── config
│   └── config.exs
├── lib
│   └── layouts
│       └── base.html.eex
├── src
│   ├── blog.json
│   ├── blog.md
│   ├── blog
│   │   ├── 2019-04-06-why-one-monitor-just-isnt-enough.md
│   │   ├── 2020-04-06-two-monitors-is-good-but-three-is-better.md
│   │   └── 2021-04-06-i-broke-my-desk-using-six-monitors-a-short-story.md
│   ├──  index.json
│   └── index.md
├── mix.exs
└── mix.lock

Enabling file specific data would be to read the configuration in index.json and allowing the index.md template to read the configuration. Furthermore, the configuration applies to subfolders as well, meaning that aside from blog.md, all of the 3 blog entry templates would also have access to the configuration listed in blog.json

This is a significant configuration change, so we should do it before we start caring about backwards compatibility.

The current installer ships with a very rough first template that we need to rework. The new version will include a landing page, a global data folder, and will bundle properly configured tailwind and esbuild packages.

Since this change will only impact new projects generated by the framework, this doesn't necessarily need to be released with 0.3.0

Currently we can only read configuration file from .exs files that use Code.eval_file/1. Users coming into Griffin might want to use JSON and YAML instead.

With a small refactor, it should be pretty easy to allow multiple formats for configuration files. This will also be useful for file and directory level data.

Currently the documentation pages in guides need some work. The pages for the Data Cascade and Collections are incomplete and the sections grouping the pages need some rethinking.

Currently permalinks override the default behaviour and allow writing to a custom path.

We can extend this further by allowing permalink to use string interpolation:

---
permalink: "my-custom-path/#{DateTime.from_iso8601(date).year}-#{title}"
---

Allowing permalinks to use interpolation will be needed to implement pagination, since rendering many pages from the same template should allow for customizable paths too.