From c33c146a174296cb16f83a722b006633c441ed29 Mon Sep 17 00:00:00 2001 From: Danilo Bargen Date: Sat, 14 Nov 2020 23:55:49 +0100 Subject: [PATCH 1/2] Docs: Add README --- docs/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..7b63a06 --- /dev/null +++ b/docs/README.md @@ -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`. From 931a5fc13c9d259f341b2dc19ffb82d9119541a7 Mon Sep 17 00:00:00 2001 From: Danilo Bargen Date: Sun, 15 Nov 2020 00:00:11 +0100 Subject: [PATCH 2/2] Docs: Document location of cache directory --- docs/src/config.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/src/config.md b/docs/src/config.md index 3aee010..38e367b 100644 --- a/docs/src/config.md +++ b/docs/src/config.md @@ -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]