Skip to content
Browse files

Small documentation update

 * A bit more info in the root README
 * Use kramdown for doc building (bluecloth has weird behaviour breaking
   YARD)
  • Loading branch information...
1 parent 7ce55e8 commit 4340289399211dbac462c17f4d14cd9bbd78b678 @ngollan ngollan committed Mar 9, 2011
Showing with 23 additions and 0 deletions.
  1. +1 −0 .yardopts
  2. +21 −0 README.mkd
  3. +1 −0 Rakefile
View
1 .yardopts
@@ -1,6 +1,7 @@
--output-dir doc/yard
--tag overridable:Overridable
--markup markdown
+--markup-provider kramdown
--exclude /generators/
merb-core/lib/**/*.rb
merb-action-args/lib/**/*.rb
View
21 README.mkd
@@ -7,3 +7,24 @@ Merb is a web development framework. For more information, check out:
[merbweb]: http://www.merbivore.com/
[merbgit]: http://github.com/merb
+
+## Modules
+
+Merb consists of the following parts:
+
+* **merb-core:** Core functionality needed to bootstrap and run an
+ application.
+* **merb-action-args:** Plugin to handle request parameters as parameters
+ to controller actions.
+* **merb-assets:** Asset handling.
+* **merb-slices:** Slices are merb's application modules.
+* **merb-cache:** Support for content caches, e.g., memcache.
+* **merb-gen:** Generators for applications, plugins, and components.
+* **merb-haml:** Support for [HAML][hamlweb]
+* **merb-helpers:** Helpers for text and HTML formatting.
+* **merb-mailer:** MVC mail sending from an application.
+* **merb-param-protection:** Filter request parameters in controllers and
+ logs.
+* **merb-exceptions:** Exception notifications as mail and through web hooks.
+
+[hamlweb]: http://haml-lang.com/
View
1 Rakefile
@@ -12,6 +12,7 @@ yard_options = [
['--output-dir', 'doc/yard' ],
['--tag', 'overridable:Overridable'],
['--markup', 'markdown' ],
+ ['--markup-provider', 'kramdown' ],
['--exclude', '/generators/' ],
]

0 comments on commit 4340289

Please sign in to comment.
Something went wrong with that request. Please try again.