Skip to content

Commit c055aec

Browse files
monkbroctmcw
authored andcommitted
docs: Provide syntax for specifying configuration (#778)
1 parent e7cba18 commit c055aec

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/CONFIG.md

+5
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ Configuration - a `documentation.yml` file - will accomplish two goals:
99
* Organization: you can put top level documentation in order of importance
1010
* Narration: you can add narrative sections - plain English writing - in
1111
between autogenerated API documentation.
12+
13+
Specify the configuration file with the `--config` command-line option.
14+
```sh
15+
$ documentation build --config documentation.yml ...
16+
```
1217

1318
Here's how `documentation.yml` works:
1419

0 commit comments

Comments
 (0)