In der Vergangenheit habe ich railsbrain.com verwendet, um eine nette und praktische Offline-API-Dokumentation zu haben.Ruby und Ruby on Rails Offline-API-Dokumentation
Aber sie halten in Version 2.3.2
Gibt es eine andere Lösung mit der neuesten Version.
Browser-basierte Lösung-19. Oktober 2017 Aktualisiert
DevDocs (https://devdocs.io/) verwendet IndexedDB Ihres Browsers die Dokumentation gespeichert werden sollen. Stellen Sie sicher, dass Sie den Anweisungen zum Installieren der Dokumentation folgen, bevor Sie offline gehen.
Für macOS versuchen Dash
Für Windows/LinuxZeal
Für verpackt HTML versuchen versuchen RubyDocs
Manual Herunterladen:
Ich benutzte diese Befehle auf meinem Server, damit ich die Dateien schneller bekommen konnte (sie wurden zwischengespeichert, gehen Sie Figur).
wget -r -k -p http://api.rubyonrails.org/
Dann Ich komprimiere den Ordner, damit ich ihn ohne Overhead herunterladen kann.
rar a -r rails_api.rar api.rubyonrails.org/
https://gist.github.com/2149669
YARD Server
Ich ziehe den Hof Format über rdoc .
gem install yard,gem rdoc --all --overwrite undyard server --gems.railsapi.com. Sie können ein benutzerdefiniertes Paket von Dokumenten für Ruby-Versionen bis 1.9, Rails bis 2.3.5 und eine Reihe von Edelsteinen erstellen und herunterladen.
'nicht found', wenn Sie herunterladen versuchen :(Dammit –
Was ist mit http://railsapi.com/?
Wenn Sie auf einem Mac sind, habe ich ein Wörterbuch mit Rails 3.0 Dokumentation http://prii.it/blog/rails-3-dictionary-update zusammengestellt. Ich hatte keine Zeit, es für Rails 3 zu tun, aber ich werde das tun, sobald ich in der Stimmung bin.
Weitere Rails-Versionen sind ebenfalls verfügbar.
nice thanks Priit – denisjacquemin
bearbeiten (Feb 2016): http://devdocs.io/ sieht okay
einfach nicht unerwähnt passieren, können Sie auch lokalen gem rdoc Server starten:
$ gem server
Starting gem server on http://localhost:8808/
localhost - - [13/Mar/2010:18:34:44 CET] "GET/HTTP/1.1" 200 22403
- ->/
Aber es fehlt Informationen über Kern Ruby-Bibliothek.
+1 für gem Server Re: fehlende Kernbibliothek Info, ich denke, dass der [rdoc-data] (http://blog.segment7.net/2010/04/01/rdoc-data-2-5-1) Edelstein dort hilft. –
DevDocs! Wow! Wo bist du all mein gewesen? Leben? –
Ich empfehle bdoc. Es ist ein Ersatz für gem server, die keinen Server benötigt und sieht viel schöner aus. Tun Sie einfach gem install bdoc; bdoc oder sehen Sie sich hier weitere Details an. Sie können bdoc here finden.
Ich werde das versuchen, danke – denisjacquemin
Ich fand Aslam's post on this topic die nützlichste, einfach zu implementieren Antwort auf diese Frage, und es funktioniert für die aktuelle Version der Rails API und Rails Guides. Danke an Aslam, dass er es zusammengefügt hat.
Grundsätzlich klonen Sie die aktuellen Rails Repo auf den Computer git und dann
bundle exec rake rdoc
aus dem Schienen-Verzeichnis ausgeführt.
Von dort können Sie den Dokumentationsordner an einen anderen Ort auf Ihrem Computer kopieren und lokal von einem Browser ausführen.
Aslam Post zeigt Ihnen auch, wie Sie eine Kopie der Rails Guides generieren.
Vor einigen Jahren habe ich FXRI zu verwenden, was ziemlich cool war: http://rubyforge.org/projects/fxri/
Obwohl, ich habe keine Ahnung, ob es noch funktioniert oder wenn es spielt schön mit rvm. Ich denke, es wurde aufgegeben. Es ist schade, es war ein sehr nettes Werkzeug.
Wenn Sie unter Windows Build your own Ruby and Rails Searchable API Doc Post ist ein guter Weg, um es zu generieren.
Innerhalb Ihrer Schienen Projekt:
API:
rake doc:rails
Guides:
Fügen Sie den RedCloth Juwel zu Ihrem Gemfile
gem 'RedCloth'
Dann
rake doc:guides
Gute Antwort. Aber, wenn ich yardoc anstelle von rdoc für api-Dokumentation verwenden möchte, was muss ich tun? – Anwar
Ich weiß, diese Frage ist ziemlich alt, aber da es immer noch hoch in Google kommt auf, wenn für „Ruby on Rails docs“ und einige Leute vorschlagen railsapi.com suchen, die um fast ein Jahr gewesen ist.
Also ich wollte http://rubydocs.org erwähnen, die die gleichen Funktionalitäten hat, die railsapi.com hatte und mehr (erzeugen Sie kombinierte Dokumente von Ruby und von Schienen mit irgendeiner Version, die Sie benötigen).
Haftungsausschluss: Ich baute http://rubydocs.org. :)
Warum muss ich auf die Vorbereitung der Dokumente warten? Kannst du nicht einfach alle möglichen Kombinationen erstellen und auf dem Server speichern lassen? – CamelBlues
RubyDocs verfolgt derzeit 281 Ruby-Versionen und 213 Rails-Versionen. Alle möglichen Kombinationen wären fast 60.000. Es ist zwar möglich, all das zu generieren und zu speichern, aber es wäre eine Verschwendung von Zeit und Raum, da nur wenige wirklich nützlich sind, denke ich. –
Nett und sehr hilfreich. Aber ich brauche stattdessen yardoc, was soll ich tun? – Anwar
Ich habe diese Frage in einer Google-Suche bei der Suche nach Offline-Dokumentation gefunden. Es hat den Job gemacht, aber ich poste diesen Link, der derzeit alle Dokumente für die Offline-Nutzung für andere Leute enthält und erleichtert, die sich hier befinden. DOCS
Sie können apidoco gem. Es ist einfach und einfach zu bedienen. Habe so viele flexible Features.
Gem: https://rubygems.org/gems/apidoco/versions/0.1.0
Text & Tabellen:.!. https://github.com/72pulses/apidoco
Ich habe dieses Juwel in meinem Projekt verwendet. Es ist gut und sehr einfach. – sufinsha
+1 für Dash Referenz. Nie zuvor davon gehört. Ich denke, ich werde es mögen !! – Meltemi
Danke für die Freigabe eines Links zu Dash. Mögen es so fa r! – GregT
Für spätere Versionen von Rubygems: 'gem rdoc --rdoc --all' – PhilT