pelican-microfeed - README.rst

-rw-r--r-- README.rst
      1 microfeed - Pelican plugin
      2 ==========================
      3 
      4 microfeeds allows for the creation of pages that each act as a feed of content
      5 separate to the main articles. The how and what:
      6 
      7  - Write articles under a category that will be used to make a microfeed.
      8  - Create the config setting MICROFEEDS as a list of these categories.
      9  - Articles in these categories are extracted early in generation so they are excluded
     10    from any article lists used in templates.
     11  - A *microfeed* object is exposed to page templates via which articles can be accessed
     12    as microfeed.*category* or microfeed[*category*] (these are equivalent).
     13  - Each microfeed will also generate an ATOM/RSS feed as usual if you have set
     14    CATEGORY_FEED_ATOM or CATEGORY_FEED_RSS.
     15  - The GENERATE_MICROFEED_POSTS setting can be set to True to make the
     16    microfeed entries still generate individual articles at the very end of
     17    generation, still keeping them hidden from all other pages except via the
     18    microfeed object.
     19