Skip to content

Commit cce5fd6

Browse files
authored
Merge pull request #703 from Josef-Friedrich/fix-mixin-doc
Clarify the option --mixin of the doc generation cli
2 parents 5c6f4e1 + 8120eb5 commit cce5fd6

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

crates/emmylua_doc_cli/src/cmd_args.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,9 @@ pub struct CmdArgs {
4848
#[arg(long, default_value = "Docs")]
4949
pub site_name: Option<String>,
5050

51-
/// The path of the mixin md file
51+
/// A directory whose contents are merged with the generated Markdown files.
52+
/// For example, to override docs/index.md, create a folder called "docs" in
53+
/// your mixin folder and create a file called "index.md" inside it.
5254
#[arg(long)]
5355
pub mixin: Option<PathBuf>,
5456

0 commit comments

Comments
 (0)