What's Changed

Bug Fixes

• auto header config heading generation function (#2474)
• fix Carbon integration (#2387)
• ci: run test action for pull requests (#2445)
• correct loadSidebar=false render structure issue (#2470)
• improve dev mode hot reload and add sourcemaps (#2402)
• improve external link detection (#2093)
• fix cross-origin links in history router mode (#1967)
• fix dependabot.yml (a321e83)
• fix docsify-server-renderer dependency (#1915)
• fix IDs containing only numbers (#2021)
• fix genIndex error for search (#1933)
• fix Husky auto-install issue after upgrade (#2325)
• fix heading parsing error (#2526)
• prevent unnecessary initial IntersectionObserver callback execution (#2523)
• prevent unnecessary themeColor deprecation notice (#2403)
• search: clean Markdown elements from search contents (#2457)
• fix skip-to-content scroll behavior (#2401)
• synchronize the page title with the title config (#2478)
• upgrade debug from 4.3.3 to 4.3.4 (#1919)
• upgrade medium-zoom from 1.0.6 to 1.0.7 (#1934)
• upgrade medium-zoom from 1.0.7 to 1.0.8 (#1939)
• upgrade node-fetch from 2.6.8 to 2.6.9 (#1996)
• fix errors when aliases contain parameters (#1855)
• enhance focus handling (#2595)
• enhance focus handling by adding smooth scrolling to the content area (#2569)
• escape HTML in search keywords (#2586)
• exclude app-name-link from sidebar text overflow styling (#2564)
• handle hash navigation to prevent duplicate callbacks (#2575)
• fix heading link overflow styling (#2568)
• improve slug generation (#2581)
• normalize slugs to NFC and remove emoji variation selectors (#2597)
• remove block display from anchor links to prevent layout issues (#2576)
• sidebar: remove ignored headings and their children (#2580)
• update relative link handling (#2579)
• adjust IntersectionObserver threshold for sticky class toggling (#2637)
• enhance accessibility for the sidebar toggle button (#2604)
• improve word breaking for code blocks in Markdown (#2636)
• include h6 headings in heading element selection (#2649)
• strip HTML tags from config.name when setting the page title (#2690)
• fix typo (#2632)
• enhance slug generation for Markdown links (#2697)
• improve sidebar navigation link selection for decoded URLs (#2708)
• implement the normalize method in html5.js (#2712)
• normalize language input and escape HTML (#2716)
• escape HTML in image, link, and media components (#2718)
• enhance embed token handling in paragraphs and table cells (870881a)
• exclude headings inside blockquotes from the sidebar TOC (#2691)
• improve cache handling and error recovery (#2744)
• keep anchor links aligned after layout changes (#2731)
• strip front matter from included Markdown files (#2752)
• fpreserve callouts when revisiting pages (#2757)

Features

• add “Skip to main content” link and update navigation behavior (#2253)
• add Google Analytics gtag.js plugin (#1702)
• allow top navigation to receive keyboard focus (#2269)
• add keyboard bindings (#2279)
• search: use Dexie.js instead of localStorage (#2464)
• support dark mode for the zoom-image plugin (#2524)
• support Prism language dependency import validation (#2489)
• support relative paths with the target config (#1751)
• v5 style overhaul (#2469)
• add GitHub-style callouts (#2487)
• support multiple keys in config helpers (#2571)
• support extracting content between fragment markers from Markdown (#2582)
• add fallback default language support (#2607)
• enhance embed handling for table cells (#2606)
• support full-line fragment identifier ignores (#2626)
• output type definitions and allow new Docsify(opts) to accept options for ESM usage (#2392)
• add pageTitleFormatter config (#2695)
• improve indexing and embedded search (#2734)

Chore

• update dependencies including axios, marked, postcss, cssnano, playwright, shell-quote, form-data, handlebars, lodash, flatted, picomatch, qs, follow-redirects, serialize-javascript, @rollup/plugin-babel, @babel/plugin-transform-modules-systemjs, postcss-nesting, @rollup/plugin-terser, and lint-staged
• update the release and changelog workflows and release script
• add and expand tests for embedded content, anchor scrolling, search, sidebar rendering, and type consumption
• add v5 upgrade documentation and refresh configuration and deployment documentation
• correct grammar in the “Edit on GitHub” section of plugins.md (18b03e4)
• remove Matomo plugin documentation and update the embedded website link (#2696)
• consolidate changelog history by removing HISTORY.md in favor of CHANGELOG.md

New Contributors

• @ablakey made their first contribution in #1935
• @wangliang181230 made their first contribution in #1933
• @dzsibi made their first contribution in #1993
• @julienw made their first contribution in #1824
• @JamesHenry made their first contribution in #2094
• @ekoz made their first contribution in #1702
• @paulhibbitts made their first contribution in #2129
• @thapasusheel made their first contribution in #2284
• @luicfrr made their first contribution in #2347
• @LBZZYZ made their first contribution in #2390
• @eldemcan made their first contribution in #2413
• @timothyjohn2015 made their first contribution in #2426
• @akshaybhinge19 made their first contribution in #2468
• @palmiak made their first contribution in #2299
• @ezeamaka2 made their first contribution in #1781
• @dajrivera made their first contribution in #2568
• @jacobsorme made th...

You can import the resource via

<script src="https://cdn.jsdelivr.net/npm/docsify@^5.0.0-rc/dist/docsify.min.js"></script>

and theme

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify@^5.0.0-rc/dist/themes/core.min.css">

Full resources can be found at https://cdn.jsdelivr.net/npm/docsify@rc/.

What's Changed

• fix: enhance accessibility for sidebar toggle button by @sy-records in #2604
• feat: enhance embed handling for table cells by @sy-records in #2606
• docs: Update intro paragraph to help improve first impressions and broaden audience by @paulhibbitts in #2602
• chore: bump actions/checkout from 4 to 5 by @dependabot[bot] in #2608
• chore: bump actions/setup-node from 3 to 5 by @dependabot[bot] in #2609
• feat: add fallback default language support by @sy-records in #2607
• fix: add test for file embed and code fragments by @jacobsorme in #2616
• test: improve file embed & code fragment tests by @jacobsorme in #2617
• chore: bump stefanzweifel/git-auto-commit-action from 6 to 7 by @dependabot[bot] in #2622
• chore: bump actions/upload-artifact from 4 to 5 by @dependabot[bot] in #2621
• chore: bump actions/setup-node from 5 to 6 by @dependabot[bot] in #2620
• chore: bump @rollup/plugin-commonjs from 28.0.1 to 29.0.0 by @dependabot[bot] in #2618
• chore: bump rimraf from 5.0.7 to 6.1.0 by @dependabot[bot] in #2619
• fix broken link to issues in CONTRIBUTING.md by @Gilbertode-iden254 in #2625
• docs: add DeployHQ deployment instructions by @MartaKar in #2627
• refactor: improve blockquoteCompiler logic by @sy-records in #2624
• docs: fix typos in some files by @Edge-Seven in #2632
• chore: bump js-yaml from 3.14.1 to 3.14.2 by @dependabot[bot] in #2634
• test: add unit test for table cell embedding functionality by @sy-records in #2629
• chore: bump glob by @dependabot[bot] in #2633
• feat: Fragment identifier full line ignore by @jacobsorme in #2626
• fix: improve word breaking for code blocks in markdown by @sy-records in #2636
• chore: bump actions/checkout from 5 to 6 by @dependabot[bot] in #2642
• chore: bump eslint-plugin-jest from 28.6.0 to 29.2.1 by @dependabot[bot] in #2640
• feat: output type definitions, and allow new Docsify(opts) to accept options for ESM usage by @trusktr in #2392
• fix: adjust intersection observer threshold for sticky class toggle by @sy-records in #2637
• delete deprecation warning that was not meant to be added in #2392 by @trusktr in #2646
• chore: bump glob from 11.1.0 to 13.0.0 by @dependabot[bot] in #2641
• fix: include h6 headings in heading element selection by @sy-records in #2649
• chore: bump marked from 16.0.0 to 17.0.1 by @Koooooo-7 in #2647
• chore: bump min-document from 2.19.0 to 2.19.2 by @dependabot[bot] in #2652
• chore: bump actions/upload-artifact from 5 to 6 by @dependabot[bot] in #2658
• chore: bump qs from 6.12.2 to 6.14.1 by @dependabot[bot] in #2655
• chore: upgrade playwright by @Koooooo-7 in #2663
• docs: Improve embed files code fragment by @jacobsorme in #2650
• docs: Add v5 upgrade docs by @paulhibbitts in #2665
• chore: bump lodash from 4.17.21 to 4.17.23 by @dependabot[bot] in #2671
• chore: bump globals from 16.0.0 to 17.0.0 by @dependabot[bot] in #2657
• chore: Build and publish v4 lib/ and themes/ folders for backwards compatibility while users transition to v5. by @trusktr in #2667
• chore: bump qs from 6.14.1 to 6.14.2 by @dependabot[bot] in #2678
• chore: bump rollup from 4.22.4 to 4.59.0 by @dependabot[bot] in #2683
• chore: bump minimatch by @dependabot[bot] in #2685
• chore: bump actions/upload-artifact from 6 to 7 by @dependabot[bot] in #2686
• fix: strip HTML tags from config.name when setting page title by @Bowl42 in #2690
• chore: bump svgo from 3.3.2 to 3.3.3 by @dependabot[bot] in #2692
• chore: bump immutable from 3.8.2 to 3.8.3 by @dependabot[bot] in #2693
• [Release]: v5.0.0-rc.4 by @sy-records in #2694

New Contributors

• @jacobsorme made their first contribution in #2616
• @Gilbertode-iden254 made their first contribution in #2625
• @MartaKar made their first contribution in #2627
• @Edge-Seven made their first contribution in #2632
• @Bowl42 made their first contribution in #2690

Full Changelog: v5.0.0-rc.3...v5.0.0-rc.4

You can import the resource via

<script src="https://cdn.jsdelivr.net/npm/docsify@^5.0.0-rc/dist/docsify.min.js"></script>

and theme

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify@^5.0.0-rc/dist/themes/core.min.css">

Full resources can be found at https://cdn.jsdelivr.net/npm/docsify@rc/.

What's Changed

• chore: bump rollup-plugin-import-css from 3.5.0 to 4.0.1 by @dependabot[bot] in #2554
• chore: bump lint-staged from 15.2.7 to 16.1.0 by @dependabot[bot] in #2553
• refactor: optimize toggleSidebar trigger conditions by @sy-records in #2557
• chore: bump stefanzweifel/git-auto-commit-action from 5 to 6 by @dependabot[bot] in #2562
• chore: bump marked from 15.0.3 to 16.0.0 by @dependabot[bot] in #2559
• fix: exclude app-name-link from sidebar text overflow styling by @sy-records in #2564
• fix: enhance focus handling by adding smooth scroll to content area by @sy-records in #2569
• chore: bump form-data from 4.0.0 to 4.0.4 by @dependabot[bot] in #2572
• feat: support config helper multi keys if supported by @Koooooo-7 in #2571
• chore: remove themes directory from package.json files list by @sy-records in #2574
• fix: handle hash navigation to prevent duplicate callbacks by @sy-records in #2575
• fix: remove block display from anchor links to prevent layout issues by @sy-records in #2576
• do not cut off bottom portion of text by @dajrivera in #2568
• docs: update sidebar link formatting by @sy-records in #2577
• chore: bump jest from 29.7.0 to 30.0.3 by @dependabot[bot] in #2561
• chore: update pull requests and issues template by @sy-records in #2584
• docs: Improve Quick start instructions by @waldyrious in #1466
• refactor: simplify auto header insertion logic by @sy-records in #2578
• chore: bump cross-env from 7.0.3 to 10.0.0 by @dependabot[bot] in #2589
• chore: bump jest-environment-jsdom from 29.7.0 to 30.0.5 by @dependabot[bot] in #2590
• chore: update launch configuration by @sy-records in #2587
• docs: Included relevant CSS vars to theme docs. by @paulhibbitts in #2592
• fix: escape HTML in search keywords and trim sidebar id by @sy-records in #2586
• docs: remove loading dialog section from quickstart guide by @sy-records in #2585
• style: CSS updates for coverpage, iframe dark mode transparency and codeblock contast by @paulhibbitts in #2593
• feat: support extract content between fragment markers from Markdown by @sy-records in #2582
• fix: enhance focus handling by @sy-records in #2595
• fix(sidebar): remove ignored headings and children by @sy-records in #2580
• fix: update relative link handling by @sy-records in #2579
• fix: improve slug generation by @sy-records in #2581
• feat: GitHub style callouts by @jhildenbiddle in #2487
• fix: normalize slugs to NFC and remove emoji variation selector by @sy-records in #2597

New Contributors

• @dajrivera made their first contribution in #2568

Full Changelog: v5.0.0-rc.1...v5.0.0-rc.3

You can import the resource via

<script src="https://cdn.jsdelivr.net/npm/docsify@^5.0.0-rc/dist/docsify.min.js"></script>

and theme

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify@^5.0.0-rc/dist/themes/core.min.css">

Full resources can be found at https://cdn.jsdelivr.net/npm/docsify@rc/.

What's Changed

Bug Fixes

• Fixed id with pure number (#2021)
• Fixed the end condition for the embed content handling loop (#1824)
• Fixed enhancement of isExternal (#2093)
• Fixed Accessibility roles and aria labels (#2304)
• Fixed genIndex error for search (#1933)
• Fixed husky can not auto install issue after upgrade (#2325)
• Fixed carbon broken (#2387)
• Fixed prevent unnecessary themeColor deprecation notice (#2403)
• Fixed dev mode hot reload and add sourcemaps (#2402)
• Fixed skip-to-content scroll behavior (#2401)
• Fixed genIndex error for search (#1933)
• Fixed When alias contains parameters, append ext error (#1855)
• Fixed Prevent initial unnecessary IntersectionObserver callback execution (#2523)
• Fixed clean markdown elements in search contents (#2457)
• Fixed auto header config heading generate func (#2474)
• Fixed fix loadSider false render structure issue (#2470)
• Fixed sync the page title regarding the title config (#2478)
• Fixed parse heading error (#2526)
• Fixed cross-origin links in history router mode (#1967)

Features

• v5 style overhaul (#2469)
• Added Google Analytics gtag.js plugin (#1702)
• Added "Skip to main content" link and update nav behavior (#2253)
• Added aria attributes to sidebar toggle and current page link (#2254)
• Allow keyboard scrolling in code blocks (#2264)
• Allow top nav to receive keyboard focus (#2269)
• Keyboard bindings support (#2279)
• Render Vue templates by default when importing Vue resources (#2327)
• Prevent focus on hidden sidebar (#2265)
• Improved error handling and response status availability (#2303)
• Use dexie.js instead of localStorage (#2464)

Removed

• Delete SSR (#2105)

Chore

• Multiple dependency upgrades.

Breaking Changes

• Legacy Browsers (for example, Internet Explorer 11) are no longer supported

New Contributors

• @ablakey made their first contribution in #1935
• @wangliang181230 made their first contribution in #1933
• @dzsibi made their first contribution in #1993
• @julienw made their first contribution in #1824
• @JamesHenry made their first contribution in #2094
• @ekoz made their first contribution in #1702
• @paulhibbitts made their first contribution in #2129
• @thapasusheel made their first contribution in #2284
• @luicfrr made their first contribution in #2347
• @LBZZYZ made their first contribution in #2390
• @eldemcan made their first contribution in #2413
• @timothyjohn2015 made their first contribution in #2426
• @akshaybhinge19 made their first contribution in #2468
• @palmiak made their first contribution in #2299
• @ezeamaka2 made their first contribution in #1781

Full Changelog: v4.13.1...v5.0.0-rc.1

Bug Fixes

• enhancement of isExternal (#2093) (6a7d15b)
• fix cross-origin links in history router mode (#1967) (2312fee)
• genIndex error for search (#1933) (68d8735)

Full Changelog: v4.13.0...v4.13.1

Bug Fixes

• CornerExternalLinkTarget config. (#1814) (54cc5f9)
• Correctly fix missing +1, -1 (#1722) (719dcbe)
• Coverpage when content > viewport height (#1744) (301b516), closes #381
• Filter null node first in hide sidebar. (#1909) (d27af3d)
• Docsify-ignore in search title. (#1872) (9832805)
• Fix search with no content. (#1878) (9b74744)
• Ignore emoji shorthand codes in URIs (#1847) (3c9b3d9), closes #1823
• Legacy bugs (styles, site plugin error, and dev server error) (#1743) (fa6df6d)
• Package.json & package-lock.json to reduce vulnerabilities (#1756) (2dc5b12)
• Packages/docsify-server-renderer/package.json & packages/docsify-server-renderer/package-lock.json to reduce vulnerabilities (#1715) (c1227b2)

Features

• Emoji build (#1766) (ba5ee26)
• Native emoji w/ image-based fallbacks and improved parsing (#1746) (35002c9), closes #779
• Plugin error handling (#1742) (63b2535)
• Virtual Routes Support #1799 #1799)

Docs

• Plugin insertion order in docs#1850#1850)
• Minor fixes to plugin docs #1774 #1774)
• Update configuration options #1773 #1773)
• Update readme#1740 #1740)
• Update the name for "Simplified Chinese" #1811 #1811)

Chore

• Update LICENSE#1912
• Sync emojis#1745 #1745)
• Update vercel link #1775 #1775)
• Remove dompurify #1490 #1490)
• Update CONTRIBUTING.md #1782 #1782)
• Improve README.md sentence #1817 #1817)

Bug Fixes

• Fix microsoft/playwright-github-action error (#1534)
• Fix Cannot read property 'classList' of null (#1527)
• Fix search for missing pathNamespaces (#1547)
• Fix buble theme missing generic fallback font (#1568)
• Fix allow " inside of an embed(#1598 )
• Fix Can not read property 'tagName' of null(#1655 )
• Fix sidebar height style in Mobile Chrome(#1683)

Chore

• Update PULL_REQUEST_TEMPLATE.md
• Upgrade docsify from 4.12.0 to 4.12.1 (#1544)
• Convert Docsify and mixins to ES classes(#1685 )
• Build test locally in Docker(#1688)

Docs

• Update deploy, change Zeit to Vercel (#1540)
• Link with plugin Pagination (#1554)
• Add dynamic code block highlighting documentation (#1626)
• Update formatUpdated (#1645)
• Add nameLink for change logo redirect. (#1651)

Bug Fixes

• Replace ES6 usage for IE11 compatibility (#1500)
• Fix theme switcher in IE11 (#1502)
• Fix isExternal check with malformed URL + tests (#1510)

Features

• Support search when there is no title (#1519)

Chore

• Fix missing carbon (#1501)
• Change Gitter to Discord throughout project (#1507)
• Upgrade docsify from 4.11.6 to 4.12.0 (#1518)
• Add test cases on isExternal. (#1515)

Docs

• Updated alias (#1511)
• Update Vercel logo link (#1520)

Bug Fixes

• Fix Vue compatibility (#1271)
• Fix sidebar title error (#1360)
• Fix cannot read property 'startsWith' of undefined (#1358)
• Fix sidebar horizontal scroll bar (#1362)
• Fix add missing argument for highlighting code (#1365)
• Fix cannot read property level of undefined (#1357)
• Fix cannot search list content (#1361)
• Fix scroll event end value (04bf1ea)
• Fix eslint warnings (#1388)
• Fix cannot search homepage content (#1391)
• Fix the sidebar links to another site (#1336)
• Fix search titles containing ignored characters (#1395)
• Fix title error when sidebar link exists with html tag (#1404)
• Fix duplicate search content when /README or / exists in the sidebar (#1403)
• Fix slugs are still broken when headings contain html (#1443)
• Fix sidebar active class and expand don't work as expect when use "space" in markdown filename (#1454)
• Fix font-size changing for code in headings (#1456)
• Fix Prevent loading remote content via URL hash (#1489)
• Fix cannot serve off /.../index.html (#1372)
• Fix Use legacy-compatible methods for IE11 (#1495)

Features

• Add Jest + Playwright Testing (#1276)
• Add Vue components, mount options, global options, and v3 support (#1409)
• Add search ignore diacritical marks (#1434)

Chore

• Upgrade node-fetch from 2.6.0 to 2.6.1 (#1370)
• Upgrade docsify from 4.11.4 to 4.11.6 (#1373)
• Upgrade debug from 4.1.1 to 4.3.0 (#1390)
• Upgrade dompurify from 2.0.17 to 2.1.0 (#1397)
• Upgrade dompurify from 2.1.0 to 2.1.1 (#1402)
• Upgrade marked from 1.2.0 to 1.2.2 (#1425)
• Upgrade dompurify from 2.1.1 to 2.2.2 (#1419)
• Upgrade prismjs from 1.21.0 to 1.22.0 (#1415)
• Upgrade marked from 1.2.2 to 1.2.3 (#1430)
• Upgrade marked from 1.2.3 to 1.2.4 (#1441)
• Upgrade debug from 4.3.0 to 4.3.1 (#1446)
• Upgrade ini from 1.3.5 to 1.3.7 (#1445)
• Upgrade dompurify from 2.2.2 to 2.2.3 (#1457)
• Upgrade debug from 4.3.1 to 4.3.2 (#1463)
• Upgrade axios from 0.20.0 to 0.21.1 (#1471)
• Upgrade prismjs from 1.22.0 to 1.23.0 (#1481)
• Upgrade dompurify from 2.2.3 to 2.2.6 (#1482)
• Upgrade dompurify from 2.2.2 to 2.2.6 (#1483)
• Upgrade playwright to 1.8.0 (#1487)
• Upgrade marked from 1.2.4 to 1.2.9 (#1486)

Bug Fixes

• Add patch for {docsify-ignore} and {docsify-ignore-all} (ce31607)