Improve posts extension with slugs, filename as default slug, and config-based default for layout

[paradox460]

Changes up a bit of logic in the posts extension to support very thin frontmatters, aiming for some defaults common to other SSGs

• If permalink is supplied, permalink is where the "post" is generated. No questions asked
• If a slug is supplied, a config value of path is read. Default is posts/:slug. Post is placed at this path
• If no value for permalink or slug is provided, filename, stripped of its extension and path components, is used, with the configured default path

This lets you write posts like this:

---
id: Post.4
title: "My new blogpost"
date: "~N[2023-10-27T21:06:43-06:00]"
---

Welcome to my blog!

And have it show up at a normal default spot in your routing tree.

[mhanberg]

Thanks for the contribution! Overall this looks good, and I am on board with the direction, but I have a couple of tweaks in mind.

If permalink is supplied, permalink is where the "post" is generated. No questions asked

Nice 😎

If a slug is supplied, a config value of path is read. Default is posts/:slug. Post is placed at this path

What do you think about making the config key permalink? I think that path here looks to be the same thing as permalink. The other change would be that you document that :title and :slug are both frontmatter keys that will be replaced in the permalink.

You could even make it capable of using any frontmatter key, but we cant punt that to another patch.

If no value for permalink or slug is provided, filename, stripped of its extension and path components, is used, with the configured default path

😎 , but path would be the default permalink, per my above suggestion.

Also, add some docs for the possible config, and noting which items will be overridden by frontmatter keys

[paradox460]

The other change would be that you document that :title and :slug are both frontmatter keys that will be replaced in the permalink.

The config-backed permalink doesn't actually support :title, only :slug. Expanding it to support title, date, and others would probably be pretty useful, but probably something that should be done as a separate transformer

[mhanberg]

The other change would be that you document that :title and :slug are both frontmatter keys that will be replaced in the permalink.

The config-backed permalink doesn't actually support :title, only :slug. Expanding it to support title, date, and others would probably be pretty useful, but probably something that should be done as a separate transformer

Ahh, sorry. What I meant with my feedback was that you'd retrieve the permalink from the config, then maybe override from the frontmatter, then replace the template variables.

[mhanberg]

Actually, now that I think about it, I think it might be better to not have a default value for the permalink, and only fallback to the filename.

So

# _posts/articles/my-post.md
id: Foo

would turn into /articles/my-post

config :tableau, Tablea.PostExtension, permalink: "/posts/:title"

# _posts/articles/my-post.md
id: Foo
title: "how to to a post"

would turn into /posts/how-to-to-a-post

and

config :tableau, Tablea.PostExtension, permalink: "/posts/:title"

# _posts/articles/my-post.md
id: Foo
title: "how to to a post"
permalink: "/tips-and-tricks/:title

would turn into /tips-and-tricks/-how-to-do-a-post

---

I think this is simpler because by default, the logic is not

• if post has slug, use default permalink
• else use filename (which also has some logic for the slug, which i'm not sure would even be used)

and becomes

• if there is a global or local permalink, use it
• else, use filename

and i think in a subsequent PR, we can introduce replacing the template variables with any arbitrary frontmatter keys, which would accomplish the goal of having a :slug (which would actually just be a userspace convention)

[mhanberg]

Thanks again for the contribution and with being receptive to feedback!

[paradox460]

Removed the slugs, and went with:

• frontmatter :permalink is always used
• If config :permalink, use title if present
• Else use filename

Doesn't work for the _posts/articles/2023-10-28-foo.md case, because the globber doesn't scan for articles beyond the first level. Future PR might be to replace dir with a glob pattern matcher

[mhanberg]

Doesn't work for the _posts/articles/2023-10-28-foo.md case, because the globber doesn't scan for articles beyond the first level. Future PR might be to replace dir with a glob pattern matcher

oh, yes i see what you mean now.

Nice, this is awesome, thanks!

[mhanberg]

I'm letting CI run now, will merge when it passes

[mhanberg]

Looks like i had an errant dbg on main, i went ahead and remvoed that. you'll need to rebase and also run the formatter.

[paradox460]

When this gets merged in I'll take a crack at the frontmatter term replacer.

[mhanberg]

merged!