Skip to content

Commit

Permalink
Document SOLARGRAPH_CACHE in README.
Browse files Browse the repository at this point in the history
  • Loading branch information
castwide committed Dec 30, 2019
1 parent 60fe8dc commit 2ca20b2
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,12 @@ The Solargraph gem ships with documentation for Ruby 2.2.2. You can download doc
$ solargraph download-core # Install the best match for your Ruby version
$ solargraph clear # Reset the documentation cache

### The Documentation Cache

Solargraph uses a cache directory to store documentation for the Ruby core and customized documentation for certain gems. The default location is `~/.solargraph/cache`, e.g., `/home/<username>/.solargraph/cache` on Linux or `C:\Users\<username>\.solargraph` on Windows.

You can change the location of the cache directory with the `SOLARGRAPH_CACHE` environment variable. This can be useful if you want the cache to comply with the XDG Base Directory Specification.

### Solargraph and Bundler

If you're using the language server with a project that uses Bundler, the most comprehensive way to use your bundled gems is to bundle Solargraph.
Expand Down

0 comments on commit 2ca20b2

Please sign in to comment.