diff options
| author | Prem Sichanugrist <s@sikachu.com> | 2012-09-01 21:37:59 -0400 |
|---|---|---|
| committer | Prem Sichanugrist <s@sikac.hu> | 2012-09-17 15:54:23 -0400 |
| commit | 31ef4cf656785a190723d2d8fb4c0fd06f4009bc (patch) | |
| tree | 582a93b9441b41c1150ae421a2a878194af6475e /guides/source/ruby_on_rails_guides_guidelines.md | |
| parent | ed62b1bf0b6fff53524c168f9615af84dea99537 (diff) | |
| download | rails-31ef4cf656785a190723d2d8fb4c0fd06f4009bc.tar.gz rails-31ef4cf656785a190723d2d8fb4c0fd06f4009bc.tar.bz2 rails-31ef4cf656785a190723d2d8fb4c0fd06f4009bc.zip | |
Convert all inline codes to Markdown syntax
Diffstat (limited to 'guides/source/ruby_on_rails_guides_guidelines.md')
| -rw-r--r-- | guides/source/ruby_on_rails_guides_guidelines.md | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/guides/source/ruby_on_rails_guides_guidelines.md b/guides/source/ruby_on_rails_guides_guidelines.md index 1699bdad3b..133e039460 100644 --- a/guides/source/ruby_on_rails_guides_guidelines.md +++ b/guides/source/ruby_on_rails_guides_guidelines.md @@ -18,7 +18,7 @@ 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 `h2`; guide sections use `h3`; subsections `h4`; etc. Capitalize all words except for internal articles, prepositions, conjunctions, and forms of the verb to be: @@ -50,7 +50,7 @@ HTML Guides ### Generation -To generate all the guides, just +cd+ into the *+guides+* directory and execute: +To generate all the guides, just `cd` into the *`guides`* directory and execute: ``` bundle exec rake guides:generate @@ -62,22 +62,22 @@ or bundle exec rake guides:generate:html ``` -(You may need to run +bundle install+ first to install the required gems.) +(You may need to run `bundle install` first to install the required gems.) -To process +my_guide.textile+ and nothing else use the +ONLY+ environment variable: +To process `my_guide.textile` and nothing else use the `ONLY` environment variable: ``` touch my_guide.textile bundle exec rake guides:generate ONLY=my_guide ``` -By default, guides that have not been modified are not processed, so +ONLY+ is rarely needed in practice. +By default, guides that have not been modified are not processed, so `ONLY` is rarely needed in practice. -To force processing all the guides, pass +ALL=1+. +To force processing all the guides, pass `ALL=1`. -It is also recommended that you work with +WARNINGS=1+. This detects duplicate IDs and warns about broken internal links. +It is also recommended that you work with `WARNINGS=1`. This detects duplicate IDs and warns about broken internal links. -If you want to generate guides in a language other than English, you can keep them in a separate directory under +source+ (eg. `source/es`) and use the +GUIDES_LANGUAGE+ environment variable: +If you want to generate guides in a language other than English, you can keep them in a separate directory under `source` (eg. `source/es`) and use the `GUIDES_LANGUAGE` environment variable: ``` bundle exec rake guides:generate GUIDES_LANGUAGE=es @@ -97,7 +97,7 @@ Please validate the generated HTML with: bundle exec rake guides:validate ``` -Particularly, titles get an ID generated from their content and this often leads to duplicates. Please set +WARNINGS=1+ when generating guides to detect them. The warning messages suggest a solution. +Particularly, titles get an ID generated from their content and this often leads to duplicates. Please set `WARNINGS=1` when generating guides to detect them. The warning messages suggest a solution. Kindle Guides ------------- |