aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChloe Kudryavtsev <toast@toastin.space>2019-01-23 19:59:54 -0500
committerChloe Kudryavtsev <toast@toastin.space>2019-01-23 19:59:54 -0500
commit11282275a7cc1e5e76d5ba765ae7052bd8965ff9 (patch)
tree767ae4d634fc53f9b8ec431b9aa32b3bf4351779
parent4e8cf90de27939e584ceea61d5dc27f17c55c9c0 (diff)
downloaddocs.a.o-11282275a7cc1e5e76d5ba765ae7052bd8965ff9.tar.bz2
docs.a.o-11282275a7cc1e5e76d5ba765ae7052bd8965ff9.tar.xz
Fix --pull mention
It's actually *required* for fetching any updates. Antora operates in "offline" mode by default.
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index 6ab04ee..8e55fac 100644
--- a/README.md
+++ b/README.md
@@ -18,7 +18,7 @@ Args of particular interest are:
- `--cache-dir`: Puts the cache into a specified directory - since the default is under home, you may want to set this to, for example, `build/cache`.
- `--clean`: Cleans up the target directory before building.
-- `--pull`: Force checking for upstream updates (components, ui, etc).
+- `--pull`: Check for upstream updates (components, ui, etc). You likely want this!
- `--to-dir`: Determines where the results are put - defaults to `build/site`, you may want to use `public`.
- `--url`: Sets the base url, which allows generating 404 and similar directories - do not add a trailing `/` - example: `https://docs.alpinelinux.org`.