Skip to content

Latest commit

 

History

History
117 lines (76 loc) · 5.07 KB

README.md

File metadata and controls

117 lines (76 loc) · 5.07 KB
Raw

A simple configurable blog/news plugin for Neos CMS

Latest Stable Version Total Downloads License

I developed this blog package for several projects including my own blog.

Build with Fusion & Yaml

Almost all functions of this blog package are based on Fusion and Yaml configurations. Just some php spice for sorting :) So it's very easy to extend and adapt to your needs.

Installation

Install via composer

composer require shel/blog

You can overwrite and modify the different content elements to your needs:

  • Shel.Blog:BlogEntry - A single blog post
  • Shel.Blog:BlogFeed - The container for blog entries which also works as archive and atom feed
  • Shel.Blog:LatestBlogEntries - Renders a sorted list of blog posts for example on your homepage

Setup a new feed

After installation you have a new page type called Blog feed. Add it to your site. For example in the site root and call it Feed. Afterwards you can configure a few things in the inspector.

  • Entries to show How many items should be shown at most.
  • Author The author which will be included in the xml.
  • Description for the feed A short description which will be included in the xml.

Html content

The html version will use your default page template and replace the mainContent area with your blog posts. All fields are inline editable except the publication date which makes it easy to modify your posts pretty fast!

Each blog post includes a paging widget which allows you to navigate to the next/previous blog posts.

Atom/Xml feed

The atom/xml version will use it's own rendering and most of the time you don't need to change anything there. It will contain the full version of your posts including html. So images and everything. All active feeds will automatically be linked in the html header as meta tags.

AMP rendering

As AMP itself is still work in progress, this feature is also work in progress. This package tries to provide a good defaults you can start with and customize it for your needs. As everything is written in Fusion, you can override and change anything you want.

After you put some blog posts online with the help of this package, Google should be able to find the AMP versions of each blog post after a few hours or days and provide the AMP version in it's search results.

Each blog post automatically includes a link in the head to it's AMP version. The package includes a default css for the AMP version and renders the primary content area.

If you have additional custom content elements in a blog post like videos and other stuff you might need to provide processors to make them compatible with AMP. See the replaceImgTags image processor as example.

Pull request with improvements to this feature are very welcome!

Customizing

The site is rendered as an array in Shel.Blog:AmpPage the object. It contains a content object in it's body section which is an array you can override and extend with additional content. By default provides basic layout components such as header, breadcrumb, blog content and pagination.

In the stylesheets section a basic css file included with this package is added inline. See the ampBlogStyles object. Replace it or add another stylesheet to modify the output. Remember the styles need to be inline for AMP.

Don't add additional javascripts as this is not supported currently with AMP.

Check out https://www.ampproject.org/docs/get_started/create to learn more on how to get started with AMP.

Debugging

Verify the output of your blog with the developer mode for AMP by loading the AMP version and adding #development=1 to the url. Open the developer tools of your browser and AMP will show you it's verification result.

Other plugins and packages you might have installed might break the AMP compatibility! Please validate the rendered code by using the browser validator or any other method described here.

Before you create an issue for the AMP mode please run the validation and add the result to the issue.

Turning of AMP rendering mode

You can turn this off with this fusion script:

root.blogEntryAmp >
prototype(Neos.Neos:Page).head.ampLink >

Routing

The routes for the sitemap and pagination are auto-included in the Settings.yaml.

Features

  • Atom feed support with the feed document type
  • Content element showing latest blog entries
  • Blog entry with it's own template and navigation elements
  • Social buttons for twitter and flattr can be configured
  • Disqus integration
  • Easily customizeable
  • AMP support for individual blog entries

You found a problem or have ideas for improvements?

Fork this project at github and create a pull request :) If you are not a developer, create an issue and tell me about your thoughts!