Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

RSS feed support #73

Closed
6 tasks done
srid opened this issue Apr 8, 2020 · 5 comments
Closed
6 tasks done

RSS feed support #73

srid opened this issue Apr 8, 2020 · 5 comments
Assignees
@srid
Labels
as-plugin Should be implemented as a plugin enhancement New feature or request proposal Proposal with exact spec yet to be fleshed out

Comments

@srid
Copy link
Owner

srid commented Apr 8, 2020 •
edited

Support for generating RSS (or Atom) feeds for a selected subset of zettels.

cf. ChrisPenner/slick-template#8

Tag-based proposal Query to route mapping could perhaps be specified in the config file `neuron.dhall`. 
{  atomFeeds :: [{ _1 = "z:zettels?tag=blog", _2 = "feed.xml"}]
, ...
}
  • Initial implementation
  • Test it in production
  • Documentation

Known issues to fix:

  • Zettel title should not be in feed item body
  • Feed title should include not only zettel title, but also site title from neuron.dhall

Improvements:

  • Add feed icon based on favicon
@srid srid added enhancement New feature or request good first issue Good for newcomers proposal Proposal with exact spec yet to be fleshed out labels Apr 8, 2020
@srid srid added the Website Neuron as used for publishing personal and organizational websites (eg: srid.ca) label May 2, 2020
@srid srid added the as-plugin Should be implemented as a plugin label Jun 21, 2020
@srid srid added this to the Next milestone Nov 15, 2020
@srid
Copy link
Owner Author

srid commented Jan 25, 2021 •
edited

Simplify this feature's UX further, by using graph connections instead of tags to query feed items. Also, use YAML frontmatter instead of touching neuron.dhall.

If Blog.md contains this metadata,

---
genRSS: True
---
...

Creates blog.rss (which exists alongside the blog.html) containing folgezettel children of the Blog.md zettel. Throws an error if not all child zettels have a date assigned (or, better, selects only those with date assigned; like 'timeline' query currently does).

This should be implemented as a plugin of course. A good candidate for contributing a neuron plugin.

@srid srid removed this from the 2.0 milestone Jan 25, 2021
@srid srid removed Website Neuron as used for publishing personal and organizational websites (eg: srid.ca) good first issue Good for newcomers labels Feb 27, 2021
@srid srid self-assigned this Feb 27, 2021
@srid srid pinned this issue Feb 27, 2021
@srid srid mentioned this issue Feb 28, 2021
Merged
@srid
Copy link
Owner Author

srid commented Feb 28, 2021 •
edited

There is a beta version of this now available in 1.9.22.0. It needs testing. Add the following to the YAML frontmatter of any note that has non-zero folgezettel children with date assigned ... and confirm that the generated atom feed is functional (the feed is automatically linked in the <head> element):

feed:
  count: 5

NOTE: This requires the feed plugin, which is enabled by default, unless you are specifying the plugins manually.

Examples:

@ghost
Copy link

ghost commented Feb 28, 2021

This works https://lost-frequencies.eu/1f695b7b.xml .. could not find any error .. maybe i will use it forreview .. i am ~1k entries behind to put tags into^^

@srid
Copy link
Owner Author

srid commented Feb 28, 2021

Note that you can combine the feed plugin with the dirtree plugin.

  1. If you enable feed in a directory zettel, then simply copying a markdown file to that directory adds that to the feed.
  2. If you use directory tags (automatically added by dirtree), then you can create a feed out of all files recursively in a directory. For eg, in a new articles-recent.md if you add [[z:zettels?tag=root/global/articles/articles-date*/**&timeline&limit=10]]# and enable feed on it, you get a RSS feed for all articles anywhere under the articles folders.

@srid srid closed this as completed in 2570f89 Mar 1, 2021
@srid
Copy link
Owner Author

srid commented Mar 1, 2021 •
edited

https://neuron.zettel.page/feed | https://www.srid.ca/neuron-feed

@srid srid unpinned this issue Mar 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@srid srid

Labels
as-plugin Should be implemented as a plugin enhancement New feature or request proposal Proposal with exact spec yet to be fleshed out
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@srid