Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for multiple documentation files #364

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

kovart
Copy link

@kovart kovart commented Dec 20, 2023

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:

  • Manifest Object Update: The 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.
  • New documentationSettings in package.json: You can now define documentationSettings in package.json, using the format [{"title": "Your Title", "filePath": "README.md"}]. You can now define up to 10 different files.
  • Backward Compatibility and CLI Behavior: In the absence of the documentationSettings field, the CLI operates as usual. However, the documentation will be published in the new format, which is now a stringified array.

@kovart kovart self-assigned this Dec 20, 2023
@kovart kovart changed the title Add support for documentation settings Add support for multiple documentation files Dec 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant