Skip to content

delete deprecation warning that was not meant to be added in #2392 #2646

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.

Sign up for GitHub

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

Merged
trusktr merged 1 commit into from
Dec 6, 2025
Merged

delete deprecation warning that was not meant to be added in #2392 #2646

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions src/core/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,13 +119,6 @@ const defaultDocsifyConfig = () => ({
* @returns {DocsifyConfig}
*/
export default function (vm, config = {}) {
if (window.$docsify) {
// eslint-disable-next-line no-console
console.warn(
'DEPRECATION: The global $docsify config variable is deprecated. See the latest getting started docs. https://docsify.js.org/#/quickstart',
);
}
Copy link
Member Author

@trusktr trusktr Dec 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Docsify with 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)


config = Object.assign(
defaultDocsifyConfig(),

Expand Down