Giter Club home page Giter Club logo

11ty-1's Introduction

M10y - RSS Aggregator Starter Based On Eleventy

M10y (abbreviation for 'multiplicity') is a simple starter pack based on Eleventy static site generator that allows you to create RSS aggregator site.

Alongside the template code, it also contains a GitHub action required to keep the site up to date.

View demo

Want to see in in action? Check out Blogworm.eu.

Instant deploy

Netlify:

Deploy to Netlify

Vercel:

Deploy with Vercel

Features

  • light / dark mode switcher + honoring color scheme preference
  • pagination
  • translation ready (separate file with static phrases)
  • automatic favicon generation
  • support for RSS and JSON feeds
  • custom avatar alongside each feed item

Setup and personalization

  1. Fork the repository.
  2. Configure the site according to your preferences - see siteConfig.js and template files.
  3. Modify the list of feeds you want to aggregate - they are located in content/sites.
    1. Each site has the following properties:
      • name - name of the site
      • url - URL of the site
      • avatar - image to display alongside the site name (e.g. favicon). During the build process the image will be downloaded, resized and served locally
      • feed - URL of the RSS or JSON feed to fetch articles from
  4. Deploy the site to Netlify or Vercel
  5. Set up the GitHub action in .github/workflows/scheduled_build.yml:
    1. Create a build hook URL and save it as a GitHub secret in your repository - e.g. NETLIFY_BUILD_HOOK_URL or VERCEL_BUILD_HOOK_URL
  6. Done! Your aggregator is up and running.

Translation file

See phrases.js for the list of translatable static phrases.

Contributions

Contributions of the following kind are welcome:

  • bug reports / fixes
  • feature suggestions / improvements of existing features

Before contributing be sure to read Code of Conduct.

License

Licensed under the MIT license.

11ty-1's People

Contributors

benigo avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.