delete deprecation warning that was not meant to be added in #2392 #2646
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
This PR removes an unintentionally added deprecation warning for the global window.$docsify config variable. The warning was mistakenly included in PR #2392 and is now being properly removed as per issue #2645.
Key Changes
- Removed console warning that incorrectly deprecated the global
window.$docsifyvariable - Preserved the actual functionality of
window.$docsifywhich is still actively used throughout the codebase
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
paulhibbitts
left a comment
paulhibbitts
left a comment
There was a problem hiding this comment.
Thanks very much @trusktr , looking at the PR Preview build the message is no longer being displayed.
| console.warn( | ||
| 'DEPRECATION: The global $docsify config variable is deprecated. See the latest getting started docs. https://docsify.js.org/#/quickstart', | ||
| ); | ||
| } |
There was a problem hiding this comment.
For reference, we chatted about not deprecating this when I was making the type definition update in #2392 (I forgot to delete one of two console warnings before merging), because in 5.0 $docsify is still the default documented way to configure and consume Docsify that is already part of 5.0-rc and that everyone is still using.
In the future we will document our new prefered way of using Docsify (perhaps in v6, or at least not in 5.0 because that's already release candidate).
As a reminder (or in case you haven't caught up with other conversations), the new new Docsify(options) API is a path path forward that:
- currently provides a type checked and IDE intellisense-enabled experience (f.e. using
Docsifywith TypeScript) - in the future will be backwards compatible with a new Custom-Element-based API:
- in JS:
const el = new Docsify(options)(same as current usage)- or
const el = document.createElement('docsify-app'); el.setAttribute('option', 'value')(create element via JS, set options on the DOM element)
- in HTML:
<docsify-app option="value" ...>(define all options in HTML, or in any templating of frameworks like React/Vue/Svelte/Solid.js/Angular/etc)
- in JS:
Summary
Remove warning that was unintentionally included in
new Docsify(opts)to accept options for ESM usage #2392Related issue, if any:
What kind of change does this PR introduce?
For any code change,
Does this PR introduce a breaking change?
Tested in the following browsers: