By the way, to be more effective in coding, it is worth choosing a source code editor with basic Ruby support (e.g. Editors and IDEsįor coding in Ruby, you can use the default editor of your operating Easily find and browse Ruby classes, modules, and methods. APIdock Ruby, Rails and RSpec documentation with users’ notes. Ruby & Rails Searchable API Docs Rails and Ruby documentation with smart searching. The one-stop web site for reference documentation about Ruby gems and Ruby C API Reference The official introduction to Ruby’s C API. Ruby Standard Library Reference Also pulled from the source code using RDoc, this reference workĭocuments the standard library. Work documents all of the core classes and modules (like String,Īrray, Symbol, etc…). Ruby Core Reference Pulled straight from the source code using RDoc, this reference The currently unreleased (trunk) version. Reference Documentation Official API Documentation The official Ruby API documentation for different versions including The Ruby Programming Wikibook A free online manual with beginner and intermediate content plus a Pragmatic Programmers’ book is available for free online. Manuals Programming Ruby The seminal work on Ruby in English, this first edition of the The absolute basics of Ruby all the way to OOP and web development. Learn Ruby the Hard Way A very good set of exercises with explanations that guide you from You don’t know how to program, start here. Learn to Program A wonderful little tutorial by Chris Pine for programming newbies. Ruby Essentials A free on-line book designed to provide a conciseĪnd easy to follow guide to learning Ruby. Stiff, this guide remains a classic for Ruby learners. Why’s (Poignant) Guide to Ruby An unconventional but interesting book that will teach you Ruby The goal is to learn the Ruby language, syntax, structure, and Ruby Koans The Koans walk you along the path to enlightenment in order to learn Getting Started Official FAQ The official frequently asked questions. The installation guide for help on installing Ruby. 文章可能有未完成或过时的内容。请先检查 () 来确定问题在 master 是否已经修掉了。再上 master 补上缺少的文件。内容参考 (ruby_on_rails_guides_guidelines.Guides, tutorials, and reference material to help you learn more about Ruby Installing RubyĪlthough you can easily try Ruby in your browser, you can also read To generate guides for the Kindle, use the following rake task: Please set `WARNINGS=1` when generating guides to detect them. Particularly, titles get an ID generated from their content and this often leads to duplicates. If you want to see all the environment variables you can use to configure the generation script just run: `source/es`) and use the `GUIDES_LANGUAGE` environment variable:īundle exec rake guides:generate GUIDES_LANGUAGE=es If you want to generate guides in a language other than English, you can keep them in a separate directory under `source` (eg. This detects duplicate IDs and warns about broken internal links. It is also recommended that you work with `WARNINGS=1`. To force processing all the guides, pass `ALL=1`. To process `my_guide.md` and nothing else use the `ONLY` environment variable:īundle exec rake guides:generate ONLY=my_guideīy default, guides that have not been modified are not processed, so `ONLY` is rarely needed in practice. To generate all the guides, just `cd` into the `guides` directory, run `bundle install` and execute: To install the latest version of Bundler, simply run the `gem install bundler` command As of this writing, you must install Bundler 1.3.5 on your device. * (api_documentation_guidelines.html#fonts)īefore generating the guides, make sure that you have the latest version of Bundler installed on your system. * (api_documentation_guidelines.html#filenames) * (api_documentation_guidelines.html#example-code) * (api_documentation_guidelines.html#wording) Please have a look at these particular sections of the (api_documentation_guidelines.html): The guides and the API should be coherent and consistent where appropriate. Use the same typography as in regular text: However, the generated HTML output will have the heading tag starting from ``.Ĭapitalize all words except for internal articles, prepositions, conjunctions, and forms of the verb to be:The title of every guide uses `h1` guide sections use `h2` subsections `h3` etc. The prologue should tell the reader what the guide is about, and what they will learn. There is comprehensive (), a ().Įach guide should start with motivational text at the top (that's the little introduction in the blue area). * About the conventions to be used in Rails documentation.Ĥ. This guide follows itself in a graceful loop, serving itself as an example. This guide documents guidelines for writing Ruby on Rails Guides.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |