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
All distributable files belong in the same directory (move all to dist/
)
#2336
Comments
This was referenced Dec 15, 2023
trusktr
changed the title
All distributable files belong in the same directory
All distributable files belong in the same directory (move all to Mar 27, 2024
dist/
)
Updated the title to reflect moving stuff into |
6 tasks
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Good catch, however I do not think we should restore the
/themes
directory.Having duplicate files in multiple locations in a single repo is a bad idea. Doing so invites confusion among those unfamiliar with the details of why duplicate files exist, which can lead to public-facing mistakes that require long-term support. This is an excellent example, and I believe it is a mistake we should correct for v5:
/lib
. For v5, the proposed location is/dist
.docsify.js
anddocsify.min.js
. For v5, this would mean something like/dist/themes/vue.css
and/dist/themes/vue.min.css
. chore: optimize compressed css script #2338I planned to address this issue in an upcoming PR as part of our v4 => v5 transition:
/dist
instead of/lib
. This is part of the v4 => v5 transition.docsify
anddocsify-cli
repos to reference/dist
instead of/lib
./lib
and/themes
to@4/lib
and@4/themes
CDN URLs. This allows v4 sites without a URL version lock to continue working when they unintentionally load v5 after its release./lib
or/themes
redirects/imports.The static redirects/imports in
/lib
and/themes
are a temporary solution. They exist only to prevent sites that load docsify resources without URL version locks from breaking when v5 releases because v4 was released in 2017 but our docs did not recommend URL version locks until mid-2020. My hope is that they will can remove them by the time v6 is released.Originally posted by @jhildenbiddle in #2335 (review)
The text was updated successfully, but these errors were encountered: