Implementation of a new DocAssembler tool #87
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Ellerbach
reviewed
Dec 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a new tool in the family of DocFx Companion Tools. It can be used to assemble documentation and assets from various locations on disk and assemble in one place. The tool will copy and change the links to the new locations of files. It can also change paths and contents using regular expressions. External links (outside of the documentation hierarchy) can be prefixed with a URL.
If the input files are validated with DocLinkChecker, the outcome of DocAssembler will also be validated with DocLinkChecker unless there are configuration errors.
The configuration is done in a JSON file. Everything is documented in the main README. There is also a Test project added with unit tests for all of the functionality.