corob-msft / cleanrepo

Tool that finds markdown (.md) files that aren't listed in any TOC file - and much more!

CleanRepo

This command-line tool helps you clean up a DocFx-based content repo. It can:

• Find and delete markdown files that aren't linked from a TOC file.
• Find and delete orphaned image (.png, .jpg, .gif, .svg) files.
• Map images to the files that reference them.
• Find and delete orphaned "shared" markdown files (includes).
• Find and replace links to redirected files.
• Replace site-relative links with file-relative links (includes image links).

Usage

Command	Description
--orphaned-topics	Use this option to find orphaned articles.
--orphaned-images	Find orphaned .png, .gif, .svg, or .jpg files. Note: The tool does not know if images are referenced in a code sample project, so we recommend not running this option on a directory that contains samples.
--orphaned-snippets	Find orphaned .cs and .vb files.
--orphaned-includes	Find orphaned INCLUDE files.
--catalog-images	Map images to the markdown/YAML files that reference them. This option generates a JSON file with the output.
--format-redirects	Format the redirection JSON file by deserializing and then serializing with pretty printing.
--replace-redirects	Find backlinks to redirected files and replace with new target.
--relative-links	Replace site-relative links with file-relative links. You must also specify the docset name for the repo.

Usage examples

• Find orphaned articles recursively (that is, in the specified directory and any subdirectories):

  CleanRepo.exe --orphaned-topics
  

  The tool will prompt you for any additional information it needs for that function, for example, the directory to look in. However, you can also pass that option in with the initial command.

  CleanRepo.exe --orphaned-topics --start-directory c:\repos\visualstudio-docs-pr\docs\ide
  

• Find and delete orphaned .png/.gif/.jpg/.svg files:

  CleanRepo.exe --orphaned-images