ceos/tealdeer
1
0
Fork 0
mirror of https://github.com/tealdeer-rs/tealdeer.git synced 2026-08-20 23:24:18 +02:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #155 from dbrgn/docs-cache-config

Browse source 
Document location of cache directory. Fixes #151.
This commit is contained in:
Danilo Bargen 2020-11-15 00:02:49 +01:00 • committed by GitHub
commit 1ebb80bb14
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/README.md Normal file
View file

@ -0,0 +1,8 @@
# Tealdeer Docs
To build the docs, install [mdbook](https://github.com/rust-lang/mdBook).
You can build the HTML with `mdbook build`.
To serve the docs on `localhost:3000` and watch for changes, use `mdbook
serve`.

10
docs/src/config.md
View file

@ -18,7 +18,15 @@ The directory where the configuration file resides may be overwritten by the
environment variable `TEALDEER_CONFIG_DIR`. Remember to use an absolute path.
Variable expansion will not be performed on the path.
## Example
## Override Cache Directory
Similarly, the cache directory where the pages are downloaded to, also follows
OS conventions. On Linux, it will usually be at `~/.cache/tealdeer/`. The path
can be overwritten using the environment variable `TEALDEER_CACHE_DIR`.
Remember to use an absolute path. Variable expansion will not be performed on
the path.
## Config Example
```toml
[display]