Skip to content
This repository was archived by the owner on Jun 1, 2023. It is now read-only.

Commit 507436c

Browse files
committed
Update generate command usage in README
1 parent 6b622be commit 507436c

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ $ make install
6767

6868
OVERVIEW: Generates Swift documentation
6969

70-
USAGE: swift-doc generate [<inputs> ...] --module-name <module-name> [--output <output>] [--format <format>]
70+
USAGE: swift-doc generate [<inputs> ...] --module-name <module-name> [--output <output>] [--format <format>] [--base-url <base-url>]
7171

7272
ARGUMENTS:
7373
<inputs> One or more paths to Swift files
@@ -78,6 +78,8 @@ $ make install
7878
-o, --output <output> The path for generated output (default:
7979
.build/documentation)
8080
-f, --format <format> The output format (default: commonmark)
81+
--base-url <base-url> The base URL used for all relative URLs in generated
82+
documents. (default: /)
8183
-h, --help Show help information.
8284

8385
The `generate` subcommand

0 commit comments

Comments
 (0)