README.md in patricia-0.1.1 vs README.md in patricia-0.1.2

- old
+ new

@@ -26,10 +26,11 @@ can figure it out. - Tooltips (`-t` flag) which show you the full file path for every directory and file in the sidebar by hovering over it. - RegEx search across all pages (if you tag your pages using a consistent pattern, you can use this to get a list of all pages for certain tags). +- GitHub Flavored Markdown/Markup support (`-g` flat) ## Installation gem install patricia @@ -60,11 +61,12 @@ Run `patricia --help` to see a list of all options. ## Markup Languages Patricia supports the following markup languages (supported file -extensions in parentheses): +extensions in parentheses) - except when using the `-g` command line +switch *(see below)*: - Markdown (`.md`, `.markdown`) via `kramdown` - Org (`.org`) via `org-ruby` - Textile (`.textile`) via `redcloth` - reStructuredText (`.rst`, `.rest`, `restx`) via `pandoc-ruby` @@ -83,9 +85,15 @@ 4. Add the file extensions to the `settings.app_content_types` hash in `PatriciaApp::App` and map them to the `text/plain` content type, if possible, so that browsers will display them on a page instead of prompting to download the file. 5. *Make sure the tests pass* + +Alternatively one can use the `-g` flag to force the usage of the +`github-markup` gem to render all pages. This lets you use GitHub Flavored +Markdown. It will render *all* pages of any markup type using this gem, not +only Markdown. As a result, when using `-g`, all the markup languages of +the `github-markup` gem are supported. ## Editor Patricia's rudimentary and completely optional markup editor can be enabled using the `-e` flat. It allows you to edit the markup for