- Add --default option
- Add --installed option
- De-document --all option. With multi-version support just added, the
complete set of documentations is quickly going to grow beyond its
current size of 500MB and 30,000 documents.
Ref #25.
@ -27,15 +27,15 @@ DevDocs requires Ruby 2.3.0, libcurl, and a JavaScript runtime supported by [Exe
git clone https://github.com/Thibaut/devdocs.git && cd devdocs
git clone https://github.com/Thibaut/devdocs.git && cd devdocs
gem install bundler
gem install bundler
bundle install
bundle install
thor docs:download --all
thor docs:download --default
rackup
rackup
```
```
Finally, point your browser at [localhost:9292](http://localhost:9292) (the first request will take a few seconds to compile the assets). You're all set.
Finally, point your browser at [localhost:9292](http://localhost:9292) (the first request will take a few seconds to compile the assets). You're all set.
The `thor docs:download` command is used to download/update individual documentations (e.g. `thor docs:download html css`), or all at the same time (using the `--all` option). You can see the list of available documentations by running `thor docs:list`.
The `thor docs:download` command is used to download pre-generated documentations from DevDocs's servers (e.g. `thor docs:download html css`). You can see the list of available documentations and versions by running `thor docs:list`. To update all downloaded documentations, run `thor docs:download --installed`.
**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 --installed` 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.
Alternatively, DevDocs may be started as a Docker container:
Alternatively, DevDocs may be started as a Docker container: