Skip to content

Commit

Permalink
Merge pull request #53 from felix-vogt/fix-documentation
Browse files Browse the repository at this point in the history
Change tool name in documentation readme of DocFxTocGenerator
  • Loading branch information
Ellerbach authored Feb 23, 2024
2 parents 60662da + 140a538 commit c8ef49f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/DocFxTocGenerator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This tool allow to generate a yaml compatible `toc.yml` file for DocFX.
## Usage

```text
TocGenerator -d <docs folder> [-o <output folder>] [-vsi]
DocFxTocGenerator -d <docs folder> [-o <output folder>] [-vsi]
-d, --docfolder Required. Folder containing the documents.
-o, --outputfolder Folder to write the resulting toc.yml in.
Expand Down Expand Up @@ -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.
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.

0 comments on commit c8ef49f

Please sign in to comment.