web-dev-qa-db-ja.com

RubyおよびRuby on RailsオフラインAPIドキュメント

以前、私はrailsbrain.comを使用して、便利で便利なオフラインAPIドキュメントを用意しました。

ただし、バージョン2.3.2で停止します。

最新バージョンのソリューションは他にありますか？.

ruby-on-railsrubyapidocumentation
39
denisjacquemin

ブラウザベースのソリューション–2017年10月19日更新

DevDocs （ https://devdocs.io/ ）は、ブラウザのIndexedDBを使用して必要なドキュメントを保存します。オフラインにする前に、ドキュメントをインストールする方法の指示に従ってください。

macOSの場合 Dash を試してください

Windows/Linuxの場合 Zeal を試してください

パッケージ化されたHTMLの場合 RubyDocs を試してください

手動ダウンロード：

私はサーバーでこのコマンドを使用して、ファイルをより速く取得できるようにしました（それらはキャッシュされ、図に移動しました）。

wget -r -k -p http://api.rubyonrails.org/

  • r-再帰的
  • k-リンクをローカルファイルを指すように変換する
  • p-HTMLページの表示に必要なすべての画像などを取得します

次に、フォルダーを圧縮して、オーバーヘッドなしでダウンロードできるようにします。

rar a -r Rails_api.rar api.rubyonrails.org/

  • a-ファイルを追加
  • r-再帰的

https://Gist.github.com/2149669

YARDサーバー

私はrdocよりもヤード形式を好みます。

  1. Gemをインストールしますgem install yard、
  2. すべてのドキュメントを再生成するgem rdoc --all --overwrite、および
  3. Gems yard server --gemsのサーバーを実行します。
63
guzart

railsapi.com 。 Rubyバージョンが1.9に、Railsが2.3.5になり、いくつかのgemが含まれる）のドキュメントのカスタムパッケージをビルドしてダウンロードできます。

24
alex.zherdev

この質問はかなり古いものですが、Googleで「Ruby on Rails docs」を検索するとまだ高くなるため、何年か前からダウンしているrailsapi.comを提案する人もいます。

だから私は http://rubydocs.org に言及したかったのですが、これはrailsapi.comが持っていたものと同じ機能を備えており、RubyとRailsのドキュメントを組み合わせて生成します必要なバージョン）。

免責事項：私は http://rubydocs.org をビルドしました。 :)

15
Manuel Meurer

Railsプロジェクト内：

API：

rake doc:Rails

ガイド：

RedCloth gemをGemfileに追加します

gem 'RedCloth'

その後

rake doc:guides
8
emj365

編集（2016年2月）： http://devdocs.io/ 正常に見える

言及しないでおくだけでなく、ローカルのgem rdocサーバーを起動することもできます。

$ gem server
Starting gem server on http://localhost:8808/
localhost - - [13/Mar/2010:18:34:44 CET] "GET / HTTP/1.1" 200 22403
- -> /

しかし、コアRubyライブラリに関する情報が不足しています。

5
Mladen Jablanović

bdocをお勧めします。これはgem serverに代わるもので、サーバーを実行する必要がなく、見栄えが格段に良くなります。 gem install bdoc; bdocを実行するか、ここで詳細を確認してください。 bdoc here を見つけることができます。

4
Lorenz

私は このトピックに関するAslamの投稿 がこの質問への回答として最も便利で実装しやすいことを発見しました。これは、現在のバージョンのRails APIおよびRailsガイドで機能します。まとめてくれたアスラムに感謝します。

基本的には、現在のRails gitリポジトリをコンピューターに複製して実行します

bundle exec rake rdoc

Railsディレクトリ内から。

そこから、ドキュメントフォルダーをコンピューターの別の場所にコピーして、ブラウザーからローカルで実行できます。

Aslamの投稿には、Railsガイドのコピーを生成する方法も示されています。

3
Charles Worthington

Macを使用している場合は、Rails 3.0ドキュメント http://prii.it/blog/Rails-3 -dictionary-update 。Rails 3のためにそれを行う時間はありませんでしたが、気分が高まったらそれを行います。

その他Railsバージョンも利用できます。

3
Priit

Windowsを使用している場合 独自のRubyとRails Searchable API Doc を作成すると、投稿を生成できます。

2
Dinesh P.R.

http://railsapi.com/ はどうですか？

2
Matěj G.

apidoco gemを使用できます。使い方は簡単でシンプルです。あまりにも多くの柔軟な機能を手に入れました。

宝石： https://rubygems.org/gems/apidoco/versions/0.1.

ドキュメント： https://github.com/72pulses/apidoco

1
Nidhin S G

オフラインドキュメントを探しているときに、Googleの検索でこの質問を見つけました。それは仕事をしましたが、私は現在ここにいる他の人々のためのオフライン使用のためのすべてのドキュメントを含んでいる（そしてそれを簡単にする）このリンクを投稿しています。 [〜＃〜]ドキュメント[〜＃〜]

0
ollaollu

数年前、私はFXRIを使用していましたが、これはかなりクールでした： http://rubyforge.org/projects/fxri/

ただし、それがまだ機能するのか、それともRVMでNiceを再生するのかはわかりません。放棄されたと思います。それは残念ですが、それはとても素晴らしいツールでした。

0
Pedro Rolo