Skip to content

Commit

Permalink
Document the prefix options; #21
Browse files Browse the repository at this point in the history
  • Loading branch information
Marek Suchánek committed Oct 21, 2022
1 parent acd7ff7 commit 6afbf5d
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/using-newdoc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,10 @@ $ newdoc --validate modules/con_proper-module.adoc

* To generate the file without the example, placeholder content, add the `--no-examples` or `-E` option when creating documents.

* To create the file without the module type prefix in the ID and the file name, add the `--no-prefixes` or `-P` option.
* By default, the content type prefix appears in the generated file name and not in the ID (anchor). To change this behavior, use the following options:
+
`--no-file-prefixes` or `-P`:: Disables the file-name prefix.
`--anchor-prefixes` or `-A`:: Enables the ID (anchor) prefix.

* To specify the directory where `newdoc` saves the generated file, add the `--target-dir=<directory>` or `-T <directory>` option.

Expand Down

0 comments on commit 6afbf5d

Please sign in to comment.