Skip to content

Commit

Permalink
Document the metadata option
Browse files Browse the repository at this point in the history
  • Loading branch information
msuchane committed Jun 5, 2024
1 parent ea8c50f commit eb5d26b
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 @@ -249,6 +249,8 @@ When generating a new file, `newdoc` warns you if a file by that name already ex

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

* To generate the file without the metadata attributes header, add the `--no-metadata` or `-D` option when creating documents.

* 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.
Expand Down Expand Up @@ -289,9 +291,10 @@ The configuration file has the following syntax:

[source,toml]
----
# These are the default values as of newdoc 2.17:
# These are the default values as of newdoc 2.18:
comments = false
examples = true
metadata = true
file_prefixes = true
anchor_prefixes = false
simplified = false
Expand Down

0 comments on commit eb5d26b

Please sign in to comment.