A TextMate 2 bundle for editing Ruby API documentation
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Commands
Syntaxes
README.md
info.plist

README.md

An(other) RDoc TextMate2 Bundle

A bundle for RDoc editing in TextMate 2.

It currently does some scoping of headings, lists, and simple verbatim sections, but the intent is to make it support the latest RDoc syntax, be injectable into Ruby comment scope, etc. Comments, suggestions, and especially patches are welcomed.

Installation

Source can be viewed or cloned via Mercurial, or if you prefer Git, via the Github mirror.

To install via Mercurial:

mkdir -p ~/Library/Application\ Support/Avian/Pristine\ Copy/Bundles/
cd ~/Library/Application\ Support/Avian/Pristine\ Copy/Bundles/
hg clone http://repo.deveiate.org/RDoc.tmbundle

To install via Git:

mkdir -p ~/Library/Application\ Support/Avian/Pristine\ Copy/Bundles/
cd ~/Library/Application\ Support/Avian/Pristine\ Copy/Bundles/
git clone git@github.com:ged/RDoc.tmbundle.git

The bundle should then be available.

Author

Michael Granger ged@FaerieMUD.org

License

Copyright (c) 2011-2012, Michael Granger All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  • Neither the name of the author/s, nor the names of the project's contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.