Skip to content

Commit c67d926

Browse files
authored
Add --site-root
1 parent 8ac31ba commit c67d926

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ To get started, create a `webdoc.conf.json` file in your project directory.
6161

6262
The only required field is `source.include` which tells webdoc where the source files are. [@webdoc/cli](packages/webdoc-cli)'s README details more configuration options
6363

64-
You can now run `webdoc` in your terminal and documentation will be generated.
64+
You can now run `webdoc` in your terminal and documentation will be generated. Be sure to serve the documentation from the folder it is generated in. If you need to serve from an ancestor directory, provide the documentation path relative to the root using the `--site-root` option, e.g. `webdoc --site-root docs`.
6565

6666
## Packages
6767

0 commit comments

Comments
 (0)