diff options
| author | Prem Sichanugrist <s@sikac.hu> | 2012-09-06 22:45:32 -0400 |
|---|---|---|
| committer | Prem Sichanugrist <s@sikac.hu> | 2012-09-17 15:54:23 -0400 |
| commit | 460c2eec24861f95e4786d3f65c18be34adf9204 (patch) | |
| tree | 3742cca200e5f64e0ee8581808a0cd50da6872a0 /guides/source | |
| parent | 41dbb58e2dd16710ffae0a44c04cf21bed5588e0 (diff) | |
| download | rails-460c2eec24861f95e4786d3f65c18be34adf9204.tar.gz rails-460c2eec24861f95e4786d3f65c18be34adf9204.tar.bz2 rails-460c2eec24861f95e4786d3f65c18be34adf9204.zip | |
Update Guides Guideline for Markdown
Diffstat (limited to 'guides/source')
| -rw-r--r-- | guides/source/ruby_on_rails_guides_guidelines.md | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/guides/source/ruby_on_rails_guides_guidelines.md b/guides/source/ruby_on_rails_guides_guidelines.md index 9977861d0b..0b070bf500 100644 --- a/guides/source/ruby_on_rails_guides_guidelines.md +++ b/guides/source/ruby_on_rails_guides_guidelines.md @@ -5,10 +5,10 @@ This guide documents guidelines for writing Ruby on Rails Guides. This guide fol -------------------------------------------------------------------------------- -Textile +Markdown ------- -Guides are written in [Textile](http://www.textism.com/tools/textile/). There is comprehensive [documentation](http://redcloth.org/hobix.com/textile/) and a [cheatsheet](http://redcloth.org/hobix.com/textile/quick.html) for markup. +Guides are written in [GitHub Flavored Markdown](http://github.github.com/github-flavored-markdown/). There is comprehensive [documentation for Markdown](http://daringfireball.net/projects/markdown/syntax), a [cheatsheet](http://daringfireball.net/projects/markdown/basics), and [additional documentation](http://github.github.com/github-flavored-markdown/) on the differences from traditional Markdown. Prologue -------- @@ -18,7 +18,17 @@ Each guide should start with motivational text at the top (that's the little int Titles ------ -The title of every guide uses `h2`; guide sections use `h3`; subsections `h4`; etc. +The title of every guide uses `h1`; guide sections use `h2`; subsections `h3`; etc. However, the generated HTML output will have the heading tag starting from `<h2>`. + +``` +Guide Title +=========== + +Section +------- + +### Sub Section +``` Capitalize all words except for internal articles, prepositions, conjunctions, and forms of the verb to be: |