Skip to content

Commit

Permalink
docs(generators): option name is generator
Browse files Browse the repository at this point in the history
  • Loading branch information
alandefreitas committed Jan 28, 2025
1 parent ab1de98 commit 40ac7f3
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/modules/ROOT/pages/generators.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
MrDocs uses a generator to convert the extracted symbols into documentation.
MrDocs supports multiple output formats that can be specified via the `generate` option:

The `generate` option can be used to specify the output format:
The `generator` option can be used to specify the output format:

[source,yaml]
----
# ...
generate: adoc
generator: adoc
# ...
----

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/partials/mrdocs-example.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
source-root: ../include
multipage: false
generate: adoc
generator: adoc
2 changes: 1 addition & 1 deletion docs/modules/ROOT/partials/mrdocs-schema-example.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@

source-root: ../include
multipage: false
generate: adoc
generator: adoc

0 comments on commit 40ac7f3

Please sign in to comment.