Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pengwynn/nesta-plugin-sluggable

Sluggable posts for Nesta CMS
https://github.com/pengwynn/nesta-plugin-sluggable

Last synced: 3 months ago
JSON representation

Sluggable posts for Nesta CMS

Host: GitHub
URL: https://github.com/pengwynn/nesta-plugin-sluggable
Owner: pengwynn
License: mit
Created: 2011-09-24T20:45:53.000Z (over 13 years ago)
Default Branch: master
Last Pushed: 2012-03-27T15:21:42.000Z (almost 13 years ago)
Last Synced: 2023-04-11T03:13:39.685Z (almost 2 years ago)
Language: Ruby
Homepage:
Size: 106 KB
Stars: 6
Watchers: 1
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.mdown
- License: LICENSE

Awesome Lists containing this project

README

# Sluggable posts for Nesta CMS

This plugin allows you to create [Nesta](http://nestacms.com) articles with a numeric filename (probably based on date and serial) but serve the page with an SEO-friendly slug, like so [http://wynnnetherland.com/linked/2011092203/making-blogazine-with-nesta](http://wynnnetherland.com/linked/2011092203/making-blogazine-with-nesta). The slug is optional. As long as the numeric filename path is included, Nesta will redirect to add the current slug.

Sluggable posts provide a few benefits:

* You can change the slug if your headline changes and Nesta will automatically find the new article.
* You don't have to know your headline and slug when you create your file.
* Mangled, truncated URLs can still find the way to the latest version of your page.

### Installation

To install add the plugin to your Nesta Gemfile

gem "nesta-plugin-sluggable"

### Setting the slug

Slugs can be set in the page [metadata](http://nestacms.com/docs/creating-content/metadata-reference):

date: 2011-09-24
slug: this-is-my-first-sluggable-post

# This is the headline

Alternatively, if not set, Sluggable will dasherize the heading to create the slug.

### Considerations

In order to avoid a `301` redirect for all sluggable page links on your site, use the `permalink` method in your templates instead of `abspath`.

### TODO

* Nesta CLI option to create posts

## Note on Patches/Pull Requests

* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Commit, do not mess with rakefile, version, or history.
(if you want to have your own version, that is fine but
bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.