/rails_wiki_engine

An engine for mounting a quick wiki into your rails app

Primary LanguageRubyMIT LicenseMIT

RailsWiki

Gem Version

License

This project rocks and uses MIT-LICENSE.

Installation

This currently depends on a working paper_trail and devise install.

To install:

Add this to your Gemfile

gem 'rails_wiki'

Then run:

rake rails_wiki:install:migrations

Then you can run the migrations

rake db:migrate

And mount the engine, it will add the route /wiki/ to whatever path you use, so might as well mount to / like:

  mount RailsWiki::Engine, at: "/"

Examples

Want to get to your articles from the host rails app?

@welcome_article = RailsWiki::Article.find_by_title('welcome')

Want to link to those articles?

<%= link_to article.pretty_title, rails_wiki.article_path(article) %>