Skip to content

docs: Adds instructions to upgrade custom plugins to v5 #2788

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

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

docs: Adds instructions to upgrade custom plugins to v5 #2788

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a7d1987
Adds instructions to upgrade custom plugins to v5 (toggleClass replac…
julienbusset Aug 14, 2026
3732481
docs: lowered 'v5 migration - replace toggleClass helper' chapter in …
julienbusset Aug 15, 2026
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
27 changes: 27 additions & 0 deletions docs/v5-upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,33 @@ View [Theme Classes](themes.md?id=classes) for more details.
- Update version from `@4` (or non-versioned) to `@5`
- Example: `//cdn.jsdelivr.net/npm/docsify/lib/plugins/emoji.min.js` becomes `//cdn.jsdelivr.net/npm/docsify@5/dist/plugins/emoji.min.js`

**Plugin Authors:** If you've written a custom plugin that uses `window.Docsify.dom.toggleClass`, this helper has been removed in v5. Replace it with the native `Element.classList` API.

Examples:
```js
// v4
window.Docsify.dom.toggleClass(element, 'className');

// v5
element.classList.toggle('className');
```

```js
// v4
window.Docsify.dom.toggleClass(element, 'action', 'className');

// v5
element.classList.action('className');
```

```js
// v4
window.Docsify.dom.toggleClass(element, isDark ? 'add' : 'remove', 'dark');

// v5
element.classList[isDark ? 'add' : 'remove']('dark');
```

## Key Differences Summary

- **CDN Path**: Changed from `/lib/` to `/dist/`
Expand Down