From 11282275a7cc1e5e76d5ba765ae7052bd8965ff9 Mon Sep 17 00:00:00 2001 From: Chloe Kudryavtsev Date: Wed, 23 Jan 2019 19:59:54 -0500 Subject: Fix --pull mention It's actually *required* for fetching any updates. Antora operates in "offline" mode by default. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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`. -- cgit v1.2.3