Sha256: 7e23f4637f7d5eaa14f6b902c1d5577a5ce8b4feee87a2419a8cc65ec27a27d1
Contents?: true
Size: 1.37 KB
Versions: 1
Compression:
Stored size: 1.37 KB
Contents
# SimpleText A simple markdown document system to present documents such as Terms & Conditions or a Privacy Policy. ## Usage Generate the migration and run migrations: ```Ruby rake simple_text:migrations:install rake db:migrate ``` Which will generate a migration for the `documents` table. Optionally, add the SimpleText css to your `application.css` ```Ruby *= require simple_text/application ``` Add the documents management routes to a protected part of the routes: ```Ruby resources :documents, only: [:edit, :update, :index, :new, :create] ``` If you've created a document, add the public route to your routes: ```Ruby get '/disclaimer', to: 'documents#show', name: 'disclaimer' ``` ## Overriding the default controller For certain functionality, overriding the `DocumentsController` is required, e.g. to make [Pundit](https://github.com/elabs/pundit) work: ```Ruby class DocumentsController < SimpleText::DocumentsController after_action :verify_authorized, :except => :index after_action :verify_policy_scoped, :only => :index after_action :make_authorized, except: :index after_action :make_scoped, only: :index def make_authorized authorize @document end def make_scoped policy_scope @documents end end ``` ## Some TODO's - Make the model name changable. - Write tests. - Make integration of [Whodunnit](https://github.com/fletcher91/whodunnit) optional via config
Version data entries
1 entries across 1 versions & 1 rubygems
Version | Path |
---|---|
simple_text-0.0.18 | README.md |