simple_text 0.0.18 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 840d9da92b00626a852cc9c61f217d1db94b4395
-  data.tar.gz: 77822454a6a2ae30c2aa41b84b5818e39e378502
+  metadata.gz: f1c45774052e0db624ec6541517bcf3670225c7f
+  data.tar.gz: af29ce833839bb7a27841bb3afec0413832128f1
 SHA512:
-  metadata.gz: 748d78721eaab520d5d2f62f3c2c87edc3a17402df044fb907312b91e352703dc23a7e3a4cb1a5f2afc08ad0a4639515417d74f8fc9fb03f44cddb731cb49098
-  data.tar.gz: 8fdde36697457167a63dc05b5538683da6bea29aa46296a317bb7518af1e8319a88bbd097ceb1335347ab1e07f4195f793e174156ab626360b83c4b60e249960
+  metadata.gz: 5493081d6aa1f0377a4adb89449e9b6d193bf9c7beea24881275eb55cacefccef080513a571ea6d3b7a2f8aac9dce107a15949d72227b088ab4c9be2c47788ab
+  data.tar.gz: 7502926bdfd79a9a68af5beeee5c40de4e59b741f4fc8d3b3fd9b88c0c2d9b19c114076e1237c88249987a196daa1f141836a947aa94ac0a9160760dc5a6000e

data/README.md

@@ -9,7 +9,7 @@ rake db:migrate
 Which will generate a migration for the `documents` table.
 
 Optionally, add the SimpleText css to your `application.css`
-```Ruby
+```Scss
 *= require simple_text/application
 ```
 
@@ -18,11 +18,22 @@ Add the documents management routes to a protected part of the routes:
 resources :documents, only: [:edit, :update, :index, :new, :create]
 ```
 
+In a document, `name` is the key for the document, `title` is shown to users above the document.
+
 If you've created a document, add the public route to your routes:
 ```Ruby
 get '/disclaimer', to: 'documents#show', name: 'disclaimer'
 ```
 
+And finally, link to your document:
+```Ruby
+link_to 'Disclaimer', disclaimer_path
+```
+
+## Customizing the view
+If you want different styling for your document, just overwrite the `documents/show` view in your application.
+The contents of the document can be rendered by calling `to_s` on the document object.
+
 ## Overriding the default controller
 For certain functionality, overriding the `DocumentsController` is required, e.g. to make [Pundit](https://github.com/elabs/pundit) work:
 ```Ruby

data/app/models/document.rb

@@ -2,4 +2,8 @@ class Document < ActiveRecord::Base
   validates_length_of :name, minimum: 4, maximum: 100
   validates_length_of :title, minimum: 4, maximum: 100
 
+
+  def to_s
+    Redcarpet::Markdown.new(Redcarpet::Render::HTML.new, {tables: true, fenced_code_blocks: false, no_styles: true, escape_html: true}).render(contents)
+  end
 end

data/app/views/documents/show.html.slim

@@ -3,4 +3,4 @@
   article.document.show
     section.content
       .contents[id="#{@document.name}"]
-        == Redcarpet::Markdown.new(Redcarpet::Render::HTML.new, {tables: true, fenced_code_blocks: false, no_styles: true, escape_html: true}).render(@document.contents)
+        == @document.to_s

data/lib/simple_text/version.rb

@@ -1,3 +1,3 @@
 module SimpleText
-  VERSION = "0.0.18"
+  VERSION = "0.0.19"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_text
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
 platform: ruby
 authors:
 - Fletcher91
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-08 00:00:00.000000000 Z
+date: 2014-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails