Skip to content
This repository has been archived by the owner on Sep 30, 2020. It is now read-only.

Commit

Permalink
Updated docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
Shogun committed Aug 18, 2016
1 parent e15f47e commit 250f902
Show file tree
Hide file tree
Showing 38 changed files with 55 additions and 52 deletions.
3 changes: 0 additions & 3 deletions .travis.yml
View file
Expand Up @@ -10,6 +10,3 @@ script: bundle exec rake spec:ci
gemfile: .travis-gemfile
notifications:
email: false
addons:
code_climate:
repo_token: 55a517f08ad82a755876285eb98b779caf3d97a6726572e45ad1377cf0cb34d0
12 changes: 7 additions & 5 deletions README.md
View file
Expand Up @@ -4,13 +4,11 @@
[![Dependency Status](https://gemnasium.com/ShogunPanda/mbrao.png?travis)](https://gemnasium.com/ShogunPanda/mbrao)
[![Build Status](https://secure.travis-ci.org/ShogunPanda/mbrao.png?branch=master)](https://travis-ci.org/ShogunPanda/mbrao)
[![Code Climate](https://codeclimate.com/github/ShogunPanda/mbrao.png)](https://codeclimate.com/github/ShogunPanda/mbrao)
[![Coverage Status](https://coveralls.io/repos/ShogunPanda/mbrao/badge.png)](https://coveralls.io/r/ShogunPanda/mbrao)
[![Coverage Status](https://coveralls.io/repos/github/ShogunPanda/mbrao/badge.svg?branch=master)](https://coveralls.io/github/ShogunPanda/mbrao?branch=master)

A content parser and renderer with embedded metadata support.

http://sw.cowtech.it/mbrao

http://rdoc.info/gems/mbrao
https://sw.cowtech.it/mbrao

## Usage

Expand Down Expand Up @@ -46,8 +44,12 @@ By including `gem mbrao` in your `Gemfile` you'll get automatic rendering of `em

You can customize the rendering engine used by including the `engine` metadata. Also, your controller will get a new `mbrao_content` helper method with the parsed content.

## API Documentation

The API documentation can be found [here](https://sw.cowtech.it/mbrao/docs).

## Contributing to mbrao

* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
* Fork the project.
Expand Down
2 changes: 1 addition & 1 deletion doc/ActionView.html
View file
Expand Up @@ -116,7 +116,7 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/ActionView/Template.html
View file
Expand Up @@ -131,7 +131,7 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/ActionView/Template/Handlers.html
View file
Expand Up @@ -116,7 +116,7 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/ActionView/Template/Handlers/MbraoTemplate.html
View file
Expand Up @@ -626,7 +626,7 @@ <h3 class="signature " id="supports_streaming?-instance_method">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/HTML.html
View file
Expand Up @@ -116,7 +116,7 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/HTML/Pipeline.html
View file
Expand Up @@ -131,7 +131,7 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/HTML/Pipeline/KramdownFilter.html
View file
Expand Up @@ -345,7 +345,7 @@ <h3 class="signature first" id="call-instance_method">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Mbrao.html
View file
Expand Up @@ -121,7 +121,7 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:10 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Mbrao/Author.html
View file
Expand Up @@ -1663,7 +1663,7 @@ <h3 class="signature first" id="as_json-instance_method">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Mbrao/Content.html
View file
Expand Up @@ -5202,7 +5202,7 @@ <h3 class="signature " id="normalize_locales-class_method">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Mbrao/ContentInterface.html
View file
Expand Up @@ -808,7 +808,7 @@ <h3 class="signature " id="get_title-instance_method">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Mbrao/ContentInterface/ClassMethods.html
View file
Expand Up @@ -379,7 +379,7 @@ <h3 class="signature " id="validate_locales-instance_method">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Mbrao/Exceptions.html
View file
Expand Up @@ -116,7 +116,7 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:10 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Mbrao/Exceptions/InvalidDate.html
View file
Expand Up @@ -124,7 +124,7 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Mbrao/Exceptions/InvalidMetadata.html
View file
Expand Up @@ -124,7 +124,7 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Mbrao/Exceptions/Parsing.html
View file
Expand Up @@ -124,7 +124,7 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Mbrao/Exceptions/Rendering.html
View file
Expand Up @@ -124,7 +124,7 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Mbrao/Exceptions/UnavailableLocalization.html
View file
Expand Up @@ -124,7 +124,7 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Mbrao/Exceptions/Unimplemented.html
View file
Expand Up @@ -124,7 +124,7 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Mbrao/Exceptions/UnknownEngine.html
View file
Expand Up @@ -124,7 +124,7 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Mbrao/Parser.html
View file
Expand Up @@ -409,7 +409,7 @@ <h3 class="signature " id="render-instance_method">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Mbrao/ParserInterface.html
View file
Expand Up @@ -125,7 +125,7 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Mbrao/ParserInterface/ClassMethods.html
View file
Expand Up @@ -1655,7 +1655,7 @@ <h3 class="signature " id="render-instance_method">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Mbrao/ParserValidations.html
View file
Expand Up @@ -125,7 +125,7 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Mbrao/ParserValidations/ClassMethods.html
View file
Expand Up @@ -339,7 +339,7 @@ <h3 class="signature " id="url?-instance_method">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Mbrao/ParsingEngines.html
View file
Expand Up @@ -118,7 +118,7 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Mbrao/ParsingEngines/Base.html
View file
Expand Up @@ -650,7 +650,7 @@ <h3 class="signature " id="separate_components-instance_method">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Mbrao/ParsingEngines/PlainText.html
View file
Expand Up @@ -567,7 +567,7 @@ <h3 class="signature " id="separate_components-instance_method">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Mbrao/RenderingEngines.html
View file
Expand Up @@ -118,7 +118,7 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Mbrao/RenderingEngines/Base.html
View file
Expand Up @@ -271,7 +271,7 @@ <h3 class="signature first" id="render-instance_method">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Mbrao/RenderingEngines/HtmlPipeline.html
View file
Expand Up @@ -812,7 +812,7 @@ <h3 class="signature first" id="render-instance_method">
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:11 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/Mbrao/Version.html
View file
Expand Up @@ -180,7 +180,7 @@ <h2>Constant Summary</h2>
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:10 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/_index.html
View file
Expand Up @@ -413,7 +413,7 @@ <h2>Namespace Listing A-Z</h2>
</div>

<div id="footer">
Generated on Tue Mar 29 12:47:21 2016 by
Generated on Thu Aug 18 15:39:10 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down
12 changes: 7 additions & 5 deletions doc/file.README.html
View file
Expand Up @@ -67,13 +67,11 @@
<a href="https://gemnasium.com/ShogunPanda/mbrao"><img src="https://gemnasium.com/ShogunPanda/mbrao.png?travis" alt="Dependency Status" /></a>
<a href="https://travis-ci.org/ShogunPanda/mbrao"><img src="https://secure.travis-ci.org/ShogunPanda/mbrao.png?branch=master" alt="Build Status" /></a>
<a href="https://codeclimate.com/github/ShogunPanda/mbrao"><img src="https://codeclimate.com/github/ShogunPanda/mbrao.png" alt="Code Climate" /></a>
<a href="https://coveralls.io/r/ShogunPanda/mbrao"><img src="https://coveralls.io/repos/ShogunPanda/mbrao/badge.png" alt="Coverage Status" /></a></p>
<a href="https://coveralls.io/github/ShogunPanda/mbrao?branch=master"><img src="https://coveralls.io/repos/github/ShogunPanda/mbrao/badge.svg?branch=master" alt="Coverage Status" /></a></p>

<p>A content parser and renderer with embedded metadata support.</p>

<p>http://sw.cowtech.it/mbrao</p>

<p>http://rdoc.info/gems/mbrao</p>
<p>https://sw.cowtech.it/mbrao</p>

<h2 id="usage">Usage</h2>

Expand Down Expand Up @@ -109,6 +107,10 @@ <h2 id="ruby-on-rails-support">Ruby on Rails support</h2>

<p>You can customize the rendering engine used by including the <code>engine</code> metadata. Also, your controller will get a new <code>mbrao_content</code> helper method with the parsed content.</p>

<h2 id="api-documentation">API Documentation</h2>

<p>The API documentation can be found <a href="https://sw.cowtech.it/mbrao/docs">here</a>.</p>

<h2 id="contributing-to-mbrao">Contributing to mbrao</h2>

<ul>
Expand All @@ -129,7 +131,7 @@ <h2 id="copyright">Copyright</h2>
</div></div>

<div id="footer">
Generated on Tue Mar 29 12:47:22 2016 by
Generated on Thu Aug 18 15:39:10 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
Expand Down

0 comments on commit 250f902

Please sign in to comment.