From 140a538694425fa87f49849ad6ba81afc55662f7 Mon Sep 17 00:00:00 2001 From: Felix Vogt <70317376+felix-vogt@users.noreply.github.com> Date: Thu, 22 Feb 2024 08:28:48 +0100 Subject: [PATCH] Change tool name in documentation of DocFxTocGenerator --- src/DocFxTocGenerator/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/DocFxTocGenerator/README.md b/src/DocFxTocGenerator/README.md index 1a31145..aa0f53d 100644 --- a/src/DocFxTocGenerator/README.md +++ b/src/DocFxTocGenerator/README.md @@ -5,7 +5,7 @@ This tool allow to generate a yaml compatible `toc.yml` file for DocFX. ## Usage ```text -TocGenerator -d [-o ] [-vsi] +DocFxTocGenerator -d [-o ] [-vsi] -d, --docfolder Required. Folder containing the documents. -o, --outputfolder Folder to write the resulting toc.yml in. @@ -66,4 +66,4 @@ The generated INDEX.md contains of an H1-header with the name of the folder, fol ## Generating mutiple child toc files -The `-m or --multitoc` option will control how far down the folder tree structure to generating toc files and allows you to generate multiple smaller, more managable TOC files for large DocFX projects. If the parameter is omitted, the default of 0 is assumed, which means only one large TOC at the root level will generated. Any value greater than 0 indicates how deep into the child folder structure TOC files will be generated, with the parent TOC having references to those located in the child folders. \ No newline at end of file +The `-m or --multitoc` option will control how far down the folder tree structure to generating toc files and allows you to generate multiple smaller, more managable TOC files for large DocFX projects. If the parameter is omitted, the default of 0 is assumed, which means only one large TOC at the root level will generated. Any value greater than 0 indicates how deep into the child folder structure TOC files will be generated, with the parent TOC having references to those located in the child folders.