pull/303/merge
Conor Heine 9 years ago
commit 43379c9965

@ -0,0 +1,17 @@
FROM ruby:2.2.2
MAINTAINER Conor Heine <conor.heine@gmail.com>
RUN apt-get update
RUN apt-get -y install git nodejs
RUN git clone https://github.com/Thibaut/devdocs.git /devdocs
RUN gem install bundler
WORKDIR /devdocs
RUN bundle install --system
RUN thor docs:download --all
EXPOSE 9292
CMD rackup -o 0.0.0.0

@ -19,6 +19,17 @@ DevDocs is free and open source. If you like it, please consider supporting my w
Unless you wish to contribute to the project, I recommend using the hosted version at [devdocs.io](http://devdocs.io). It's up-to-date and works offline out-of-the-box. Unless you wish to contribute to the project, I recommend using the hosted version at [devdocs.io](http://devdocs.io). It's up-to-date and works offline out-of-the-box.
Alternatively, DevDocs may be started as a Docker container:
```
# First, build the image
git clone https://github.com/Thibaut/devdocs.git && cd devdocs
docker build -t thibaut/devdocs .
# Finally, start a DevDocs container (access http://localhost:9292)
docker run --name devdocs -d -p 9292:9292 thibaut/devdocs
```
DevDocs is made of two separate pieces: a Ruby scraper that generates the documentation and metadata, and a JavaScript app powered by a small Sinatra app. DevDocs is made of two separate pieces: a Ruby scraper that generates the documentation and metadata, and a JavaScript app powered by a small Sinatra app.
DevDocs requires Ruby 2.2.2, libcurl, and a JavaScript runtime supported by [ExecJS](https://github.com/sstephenson/execjs#readme) (included in OS X and Windows; [Node.js](http://nodejs.org/) on Linux). Once you have these installed, run the following commands: DevDocs requires Ruby 2.2.2, libcurl, and a JavaScript runtime supported by [ExecJS](https://github.com/sstephenson/execjs#readme) (included in OS X and Windows; [Node.js](http://nodejs.org/) on Linux). Once you have these installed, run the following commands:
@ -37,6 +48,17 @@ The `thor docs:download` command is used to download/update individual documenta
**Note:** there is currently no update mechanism other than `git pull origin master` to update the code and `thor docs:download` to download the latest version of the docs. To stay informed about new releases, be sure to [watch](https://github.com/Thibaut/devdocs/subscription) this repository and/or subscribe to the [newsletter](http://eepurl.com/HnLUz). **Note:** there is currently no update mechanism other than `git pull origin master` to update the code and `thor docs:download` to download the latest version of the docs. To stay informed about new releases, be sure to [watch](https://github.com/Thibaut/devdocs/subscription) this repository and/or subscribe to the [newsletter](http://eepurl.com/HnLUz).
Alternatively, DevDocs may be started as a Docker container:
```
# First, build the image
git clone https://github.com/Thibaut/devdocs.git && cd devdocs
docker build -t thibaut/devdocs .
# Finally, start a DevDocs container (access http://localhost:9292)
docker run --name devdocs -d -p 9292:9292 thibaut/devdocs
```
## Vision ## Vision
DevDocs aims to make reading and searching reference documentation fast, easy and enjoyable. DevDocs aims to make reading and searching reference documentation fast, easy and enjoyable.

Loading…
Cancel
Save