Add support for multiple documentation files #364
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 PR introduces the ability to specify multiple documentation files, each with its own title, while maintaining backward compatibility. No modifications are required for existing projects.
Key Changes:
documentation
field in the manifest object now accepts a stringified array of objects in the format[{"title": "Your Title", "ipfsUrl": "QmZnLK4..."}]
. This replaces the previous format with a reference to a single documentation file.documentationSettings
in package.json: You can now definedocumentationSettings
in package.json, using the format[{"title": "Your Title", "filePath": "README.md"}]
. You can now define up to 10 different files.documentationSettings
field, the CLI operates as usual. However, thedocumentation
will be published in the new format, which is now a stringified array.