-
-
Notifications
You must be signed in to change notification settings - Fork 5.7k
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
chore: Remove the src directory from packages.json's files #1344
Conversation
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/docsify-core/docsify-preview/3g7nmuq1y |
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit f40c1c4:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a breaking change. We should not remove src. Someone may depend on it. Why did you remove it?
@QingWei-Li Hello! We've been trying to save breaking changes for v5, but first we're stabilizing the code with tests (see Playwright PR, and some new files like In my opinion, src files should always be published. This allows people to integrate source files into their own build systems which may be preferable over consuming built files (something I do quite often). |
@trusktr IMO, I don't think we should publish that. is someone who wants to use the source file, they can very well pull it from the Github and also publishing the src folders will increase the package size unnecessary. This is not a breaking change cause we never recommended nor stated anywhere in the docs to use these files and even if we did so, we should fix that. |
Summary
close #1343
What kind of change does this PR introduce? (check at least one)
If changing the UI of default theme, please provide the before/after screenshot:
Does this PR introduce a breaking change? (check one)
If yes, please describe the impact and migration path for existing applications:
The PR fulfills these requirements:
fix #xxx[,#xxx]
, where "xxx" is the issue number)You have tested in the following browsers: (Providing a detailed version will be better.)
If adding a new feature, the PR's description includes:
To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.