web-dev-qa-db-ger.com

Offline-API-Dokumentation für Ruby und Ruby on Rails

In der Vergangenheit habe ich railsbrain.com benutzt, um eine nette und praktische Offline-API-Dokumentation zu haben.

Bei Version 2.3.2 hören sie jedoch auf

Gibt es eine andere Lösung mit der neuesten Version?.

38
denisjacquemin

Browser-basierte Lösung - Aktualisiert am 19. Oktober 2017

DevDocs ( https://devdocs.io/ ) verwendet die IndexedDB Ihres Browsers, um die gewünschte Dokumentation zu speichern. Stellen Sie sicher, dass Sie die Anweisungen zum Installieren der Dokumente befolgen, bevor Sie offline gehen.


Für macOS try Dash

Für Windows/Linux try Zeal

Für Paket HTML try RubyDocs

Manueller Download :

Ich habe diese Befehle auf meinem Server verwendet, damit ich die Dateien schneller erhalten konnte (sie wurden zwischengespeichert, gehen Sie zu Abbildung).

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

  • r - rekursiv 
  • k - konvertiert Links, um auf lokale Dateien zu verweisen 
  • p - alle Bilder usw. abrufen, um die HTML-Seiten anzuzeigen

Dann komprimiere ich den Ordner, damit ich ihn ohne Overhead herunterladen kann.

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

  • a - Dateien hinzufügen
  • r - rekursiv

https://Gist.github.com/2149669

YARD Server

Ich ziehe das Yard-Format dem rdoc vor. 

  1. Installiere den Edelstein gem install yard
  2. Generieren Sie die gesamte Dokumentation gem rdoc --all --overwrite und
  3. Führen Sie den Server für die Gems yard server --gems aus.
59
guzart

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.

24
alex.zherdev

Mir ist klar, dass diese Frage ziemlich alt ist, aber da Google bei der Suche nach "Ruby on Rails docs" immer noch hoch auftaucht, und mehrere Leute meinen, ist dies nun mit schienenapi.com der Fall, der seit fast einem Jahr ausfällt.

Also wollte ich http://rubydocs.org erwähnen, das die gleichen Funktionalitäten hat wie railsapi.com und mehr (generieren Sie kombinierte Dokumente von Ruby und Rails mit jeder Version, die Sie benötigen).

Haftungsausschluss: Ich habe http://rubydocs.org gebaut. :)

14
Manuel Meurer

In Ihrem Rails-Projekt:

API:

rake doc:Rails

Führungen:

Fügen Sie den RedCloth-Edelstein Ihrem Gemfile hinzu

gem 'RedCloth'

Dann

rake doc:guides
8
emj365

Bearbeiten (Feb 2016): http://devdocs.io/ sieht okay aus

Um nicht unerwähnt zu bleiben, können Sie auch den 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 fehlen Informationen über die Ruby-Bibliothek.

5

Ich empfehle bdoc. Es ist ein Ersatz für gem server, für den kein Server erforderlich ist und es sieht viel schöner aus. Machen Sie einfach gem install bdoc; bdoc oder sehen Sie sich hier weitere Details an. Sie finden bdoc hier .

4
Lorenz

Ich fand Aslams Beitrag zu diesem Thema als die nützlichste, einfach zu implementierende Antwort auf diese Frage, und sie funktioniert für die aktuelle Version der Rails-API und der Rails-Guides. Danke an Aslam für die Zusammenstellung.

Grundsätzlich klonen Sie das aktuelle Rails-Git-Repo auf Ihren Computer und führen es aus

bundle exec rake rdoc

aus dem Rails-Verzeichnis.

Von dort können Sie den Dokumentationsordner an einen anderen Ort auf Ihrem Computer kopieren und lokal von einem Browser aus ausführen.

Der Beitrag von Aslam zeigt Ihnen auch, wie Sie eine Kopie der Rails Guides erstellen.

3

Wenn Sie mit einem Mac arbeiten, habe ich ein Wörterbuch mit der Dokumentation zu Rails 3.0 zusammengestellt http://prii.it/blog/Rails-3-dictionary-update . Ich hatte keine Zeit, dies für Rails 3 zu tun, werde es aber tun, wenn ich in der Stimmung bin.

Andere Rails-Versionen sind ebenfalls verfügbar.

3
Priit

Wenn Sie sich mit Windows Erstellen Sie Ihr eigenes Ruby and Rails Searchable API-Dokument beiteln, ist eine gute Möglichkeit, es zu erstellen.

2
Dinesh P.R.

Was ist mit http://railsapi.com/ ?

2
Matěj G.

Sie können apidoco gem verwenden. Es ist leicht und einfach zu bedienen. Ich habe auch so viele flexible Funktionen.

Gem: https://rubygems.org/gems/apidoco/versions/0.1.0

Dokumente: https://github.com/72pulses/apidoco

1
Nidhin S G

Ich habe diese Frage in einer Google-Suche gefunden, während ich nach Offline-Dokumentation gesucht habe. Es hat den Job gemacht, aber ich poste diesen Link, der derzeit alle Dokumente für die Offline-Verwendung enthält (und es einfacher macht) für andere Personen, die sich hier befinden. DOCS

0
ollaollu

Vor einigen Jahren habe ich FXRI benutzt, was ziemlich cool war: http://rubyforge.org/projects/fxri/

Ich habe zwar keine Ahnung, ob es noch funktioniert oder ob es mit rvm Nice spielt. Ich denke, es wurde aufgegeben. Es ist allerdings schade, es war ein sehr schönes Werkzeug.

0