diff options
| author | Chloe Kudryavtsev <toast@toastin.space> | 2019-01-23 19:59:54 -0500 |
|---|---|---|
| committer | Chloe Kudryavtsev <toast@toastin.space> | 2019-01-23 19:59:54 -0500 |
| commit | 11282275a7cc1e5e76d5ba765ae7052bd8965ff9 (patch) | |
| tree | 767ae4d634fc53f9b8ec431b9aa32b3bf4351779 /README.md | |
| parent | 4e8cf90de27939e584ceea61d5dc27f17c55c9c0 (diff) | |
| download | docs.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.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 2 |
1 files changed, 1 insertions, 1 deletions
@@ -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`. |