liquid-utilities / liquid-utilities/feed-json

Custom entries/extensions support may need added

Open
#2 0 comments 0 reactions 0 assignees View on GitHub
enhancement good first issue
Dominant language
Liquid
Stars
2
Forks
0
PR merge metrics
No merged PRs in 30d

Description

According to [JSON Feed -- Spec -- Extensions][link__json_feed__spec__extensions] `"items"` may contain custom objects, provided that the key name is prefixed by an underscore, eg...

```json
{
"items": [
{
"_entry_name": {
"about": "http://example.com/json-feed-extensions/",
"something": "value"
}
}
]
}
```

Likely this feature should be added as FrontMatter configuration for `feed.json` files, for example something like...

**`feed.json` (snip)**

```yaml
custom_entries:
- entry_name
```

[link__json_feed__spec__extensions]: https://jsonfeed.org/version/1#extensions

Contributor guide

Open the contributing guide

Research direction

Start by locating how feed.json FrontMatter is read and how JSON Feed items are generated; the issue proposes a custom_entries configuration. Check the JSON Feed extensions specification linked in the issue, and consider the work complete when configured underscore-prefixed custom objects are emitted in items without affecting standard entries.

Written by the indexing model from the issue text.

Assessment

Tech stack
jekyll
Domain
content
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.