CHANGELOG.md

4.13.0 (2022-10-26)

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. (#1909) (d27af3d)
• fix 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)

4.12.2 (2022-01-06)

Bug Fixes

• Add escapeHtml for search (#1551) (c24f7f6)
• allow also " inside of an embed (ec16e4a)
• buble theme missing generic fallback font (#1568) (37d9f0e)
• Cannot read property 'classList' of null (#1527) (d6df2b8), closes /github.com/docsifyjs/docsify/pull/1527#issuecomment-793455105
• Cannot read property 'tagName' of null (#1655) (c3cdadc), closes #1154 /github.com/docsifyjs/docsify/blob/develop/src/core/router/history/html5.js#L25-L27 /github.com/docsifyjs/docsify/blob/develop/src/core/router/history/hash.js#L47-L49
• upgrade debug from 4.3.2 to 4.3.3 (#1692) (40e7749)
• Upgrade docsify from 4.12.0 to 4.12.1 (#1544) (d607f6d)
• upgrade dompurify from 2.2.6 to 2.2.7 (#1552) (407e4d4)
• Upgrade dompurify from 2.2.6 to 2.2.7 (#1553) (93c48f3)
• upgrade dompurify from 2.2.7 to 2.2.8 (#1577) (0dd44cc)
• upgrade dompurify from 2.2.7 to 2.3.0 (#1619) (66303fe)
• upgrade dompurify from 2.2.8 to 2.2.9 (#1600) (baf5a8a)
• upgrade dompurify from 2.2.9 to 2.3.0 (#1616) (b07fa3c)
• upgrade dompurify from 2.3.0 to 2.3.1 (#1635) (5ac8237)
• upgrade dompurify from 2.3.1 to 2.3.2 (#1647) (ff6acfa)
• upgrade node-fetch from 2.6.1 to 2.6.2 (#1641) (6ee1c14)
• upgrade node-fetch from 2.6.2 to 2.6.4 (#1649) (6f81034)
• upgrade node-fetch from 2.6.4 to 2.6.5 (#1654) (d16e657)
• upgrade node-fetch from 2.6.5 to 2.6.6 (#1668) (cefe3f8)

4.12.1 (2021-03-07)

Bug Fixes

• isExternal check with malformed URL + tests (#1510) (ff2a66f), closes #1477 #1126 #1489
• Replace ES6 usage for IE11 compatibility (#1500) (a0f61b2)
• theme switcher in IE11 (#1502) (8cda078)
• Upgrade docsify from 4.11.6 to 4.12.0 (#1518) (47cd86c)

Features

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

Chore

• Fix missing carbon (#1501)
• Change Gitter to Discord throughout project (#1507)
• Add test cases on isExternal (#1515)

4.12.0 (2021-02-08)

Bug Fixes

• add missing argument for highlighting code (#1365) (f35bf99)
• Can't search homepage content (#1391) (25bc9b7)
• Cannot read property 'startsWith' of undefined (#1358) (9351729)
• Cannot read property level of undefined (#1357) (4807e58)
• cannot search list content (#1361) (8d17dcb)
• duplicate search content when /README or / exists in the sidebar (#1403) (7c3bf98)
• package.json & package-lock.json to reduce vulnerabilities (#1419) (69b6907)
• packages/docsify-server-renderer/package.json & packages/docsify-server-renderer/package-lock.json to reduce vulnerabilities (#1389) (62cd35e)
• packages/docsify-server-renderer/package.json & packages/docsify-server-renderer/package-lock.json to reduce vulnerabilities (#1418) (58fbca0)
• Prevent loading remote content via URL hash (#1489) (14ce7f3), closes #1477 #1126
• search on homepage test (#1398) (ee550d0)
• search titles containing ignored characters (#1395) (a2ebb21)
• sidebar active class and expand don't work as expect when use "space" in markdown filename (#1454) (dcf5a64), closes #1032
• sidebar horizontal scroll bar (#1362) (b480822)
• sidebar title error (#1360) (2100fc3)
• slugs are still broken when headings contain html (#1443) (76c5e68)
• the sidebar links to another site. (#1336) (c9d4f7a)
• title error when sidebar link exists with html tag (#1404) (8ccc202), closes #1408
• Unable to navigate on server without default index support (#1372) (759ffac)
• upgrade debug from 4.1.1 to 4.3.0 (#1390) (ae45b32)
• upgrade debug from 4.3.0 to 4.3.1 (#1446) (bc3350f)
• upgrade debug from 4.3.1 to 4.3.2 (#1463) (df21153)
• upgrade docsify from 4.11.4 to 4.11.6 (#1373) (c2d12ed)
• upgrade dompurify from 2.0.17 to 2.1.0 (#1397) (1863d8e)
• upgrade dompurify from 2.1.0 to 2.1.1 (#1402) (8cf9fd8)
• upgrade dompurify from 2.2.2 to 2.2.3 (#1457) (720d909)
• upgrade dompurify from 2.2.2 to 2.2.6 (#1483) (eee9507)
• upgrade dompurify from 2.2.3 to 2.2.6 (#1482) (7adad57)
• upgrade marked from 1.2.4 to 1.2.9 (#1486) (716a7fa)
• upgrade prismjs from 1.21.0 to 1.22.0 (#1415) (0806f48)
• upgrade prismjs from 1.22.0 to 1.23.0 (#1481) (5f29cde)
• Use legacy-compatible methods for IE11 (#1495) (06cbebf)

Features

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

4.11.6 (2020-08-22)

Bug Fixes

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

4.11.5 (2020-08-21)

Bug Fixes

• Russian language link error (#1270) (2a52460)
• {docsify-updated} in the sample code is parsed into time (#1321) (2048610)
• Add error handling for missing dependencies (fixes #1210) (#1232) (3673001)
• after setting the background image, the button is obscured (#1234) (34d918f)
• convert {docsify-ignore} and {docsify-ignore-all} to HTML comments (#1318) (90d283d)
• fallback page should use path not file location (#1301) (2bceabc)
• Fix search error when exist translations documents (#1300) (b869019)
• gitignore was ignoring folders in src, so VS Code search results or file fuzzy finder were not working, etc (d4c9247)
• packages/docsify-server-renderer/package.json & packages/docsify-server-renderer/package-lock.json to reduce vulnerabilities (#1250) (d439bac)
• search can not search the table header (#1256) (3f03e78)
• Search plugin: matched text is replaced with search text (#1298) (78775b6)
• the uncaught typeerror when el is null (#1308) (952f4c9)
• Updated docs with instructions for installing specific version (fixes #780) (#1225) (b90c948)
• upgrade medium-zoom from 1.0.5 to 1.0.6 (3beaa66)
• upgrade tinydate from 1.2.0 to 1.3.0 (#1341) (59d090f)

Features

• search: add pathNamespaces option (d179dde)
• Add title to sidebar links (#1286) (667496b)

4.11.4 (2020-06-18)

Bug Fixes

• consistent location of search result (e9dd2de)
• cover overlapping sidebar by removing z-index (0bf03f5)
• cross-origin url cannot be redirected when "externalLinkTarget" is set to "_self" and "routerMode" is set to "history". (#1062) (fd2cec6), closes #1046 #1046 #1046
• default html img resize if no height included (#1065) (9ff4d06)
• fixed target and rel issue (fixes #1183) (3d662a5)
• Inconsistent search and body rendering (dcb0aae)
• rendering cover width bug (717991c)
• search does not find the contents of the table (#1198) (31010e4)
• The search error after setting the ID in the title (#1159) (6e554f8)
• upgrade docsify from 4.10.2 to 4.11.2 (60b7f89)

Features

• added html sanitizer for remote rendering (#1128) (714ef29)
• update src/core/index.js to export all global APIs, deprecate old globals in favor of a single global DOCSIFY, and add tests for this (7e002bf)

Reverts

• Revert "Updated docs site dark and light mode with switch and redesigned search bar using docsify-darklight-theme" (#1207) (26cb940), closes #1207 #1182

4.11.3 (2020-03-24)

Bug Fixes

• fix: digit issue with sidebar (complete REVERT to old method) (154abf5)

4.11.2 (2020-03-09)

Bug Fixes

• fixed rendering of color in coverpage issue (406670c)

4.11.1 (2020-03-09)

4.11.0 (2020-03-09)

Bug Fixes

• emojis in titles not working correctly and update (#1016) (b3d9b96)
• searching table content (6184e50)
• stage modified files as part of pre-commit hook (#985) (5b77b0f)
• config initialization and coercion (#861)
• strip indent when embedding code fragment (#996)
• Ensure autoHeader dom result is similar to parsed H1 (#811)
• upgrade docsify from 4.9.4 to 4.10.2 (#1054) (78290b2)
• upgrade medium-zoom from 1.0.4 to 1.0.5 (39ebd73)
• upgrade prismjs from 1.17.1 to 1.19.0 (9981c43)

Features

• configure pre-commit hook (#983) (eea41a1)
• Add a prepare script. (efbea24)
• added capability to add css class and id to images + links + refactoring (#820) (724ac02)
• added dark mode to docs closes #1031 (dc43d3c)
• new option hideSidebar (#1026) (b7547f1)
• new option topMargin (#1045) (8faee03)

Docs

• update docs for the name config option (#992)
• about cache (#854)
• removed FOSSA badge
• documented __colon__ tip (#1025)

Chore

• Migrate relative links to absolute in embedded markdown (#867)
• smarter scroll behavior (#744)
• improve basic layout style (#884)
• There are currently {three=>four} themes available. (#892)
• Added a redirect for images to show up in Amplify (#918)
• removed the escaping of the name of sidebar (#991)
• Eslint fixes for v4x (#989)
• added github Actions for CI (#1000)
• Add a prepare script. (#1010)
• chore(GH-action): using ubuntu 16 and removed node 8 from CI
• chore: add config (#1014)
• chore(stale): added enhancement label to exemptlabels
• chore(stale): added bug label to exemptlabels
• .markdown-section max-width 800px to 80% (#1017)
• changed the CDN from unpkg to jsDelivr #1020 (#1022)
• migrate CI to github, refactore CI and npm scripts, linting fixes (#1023)
• chore(readme): added CI badges and fixed the logo issue
• added new linter config (#1028)

4.10.2 (2019-12-16)

4.10.0 (2019-12-16)

Bug Fixes

• fixed security alert for chokidar(update dep) (a62b037)
• npm audit issues (#934) (615205c)
• package security alerts (f5f1561)
• security alerts of cssnano (d7d5c8f)

4.9.4 (2019-05-05)

4.9.2 (2019-04-21)

Bug Fixes

• re-render gitalk when router changed (11ea1f8)

Features

• allows relative path, fixed #590 (31654f1)

4.9.1 (2019-02-21)

Bug Fixes

• github assets url (#774) (140bf10)

4.9.0 (2019-02-19)

Bug Fixes

• task list rendering (Fix #749) (#757) (69ef489)
• upgrade npm-run-all (049726e)

Features

• search-plugin: add namespace option (#706) (28beff8)
• Add new theme "dolphin" (#735) (c3345ba)
• Provide code fragments feature (#748) (1447c8a)

4.8.6 (2018-11-12)

Bug Fixes

• IE10 compatibility (#691) (4db8cd6)

4.8.5 (2018-11-02)

Bug Fixes

• expose version info for Docsify, fixed #641 (aa719e3)

4.8.4 (2018-11-01)

Bug Fixes

• cover: Compatible with legacy styles, fixed #677 (#678) (1a945d4)

4.8.3 (2018-11-01)

Fix the last release files has the old version marked...

4.8.2 (2018-11-01)

Bug Fixes

• cover button style, fixed #670, fixed #665 (#675) (fcd1087)
• update match regex (#669) (2edf47e)
• use copy of cached value (#668) (5fcf210)
• compiler: import prism-markup-templating, fixed #672 (#676) (fdd8826)

Features

• add heading config id (#671) (ab19b13)

4.8.1 (2018-10-31)

Bug Fixes

• ssr package dep, fixed #605 (2bc880d)
• compiler: extra quotes for codeblock (4f588e0)
• compiler: prevent render of html code in paragraph, fixed #663 (d35059d)

Features

• upgrade PrismJS, fixed #534 (4805cb5)

4.8.0 (2018-10-31)

Bug Fixes

• Cache TOC for later usage in the case of cached file html (#649) (9e86017)
• improve external script plugin (#632) (50c2434)
• missing variable declaration (#660) (1ce37bd)
• Remove target for mailto links (#652) (18f0f03)
• Update getAllPath query selector (#653) (f6f4e32)
• Update vue.styl (#634) (bf060be)

Features

• Add docsify version to $window.docsify object (#641) (94bc415), closes #521
• compiler: support embedded mermaid (#629) (42ea8af)
• Add hideOtherSidebarContent option (#661) (4a23c4a)
• Allow base64, external, and relative logo values (#642) (0a0802a), closes #577
• upgrade marked to 0.5.x, fixed #645, close #644 (#662) (a39b214)

4.7.1 (2018-08-30)

4.7.0 (2018-06-29)

Bug Fixes

• alldow addition content in sidebar, fix #518, fix 539 (#543) (04b36b0)
• async install config, fixed #425 (e4e011c)
• loading embed files synchronously, fixed #525, fixed #527 (#544) (feea7f9)
• path include chinese character cause hilight bug (#556) (a5f333a)

Features

• add logo option, #264 (#541) (ee72dd0)
• add unpkg field, close #531 (#558) (5c0de0a)
• support image resizing, resolve #508 (#545) (3a7ad62)

4.6.10 (2018-03-25)

Bug Fixes

• async install config, fixed #425 (e4e011c)

4.6.9 (2018-03-10)

Bug Fixes

• upgrade medium-zoom, fixed #417 (6a3d69a)

4.6.8 (2018-03-06)

Bug Fixes

• resolve path of image and embed files, fixed #412 (bfd0d18)

4.6.7 (2018-03-03)

Bug Fixes

• layout css, fixed #409 (aeb692e)

4.6.6 (2018-03-03)

4.6.5 (2018-03-03)

Bug Fixes

• navbar: Now Navbar isn't append to DOM when loadNavbar is falsy (#407) (0933445)

Features

• config: Add 404 page options. (#406) (9b3b445)

4.6.4 (2018-03-01)

Bug Fixes

• render: Disable markdown parsing when the file is an HTML (#403) (278a75e)

Features

• fetch: Add fallback languages configuration. (#402) (ecc0e04)

4.6.3 (2018-02-15)

Bug Fixes

• hook: beforeEach don't work, fixed #393 (6a09059)

4.6.2 (2018-02-14)

Bug Fixes

• embed: broken in IE, fixed #389, fixed #391 (45a7464)
• embed: init value (890a7bf)

4.6.1 (2018-02-12)

Bug Fixes

• embed compatible ssr (dc0c3ce)
• embed async fetch embed files, fixed #387

4.6.0 (2018-02-11)

Bug Fixes

• search: custom clear button, fixed #271 (864aa18)
• search: escape special characters for search, fixed #369 (9755439)
• build config (342438f)
• button style for coverpage, fixed #362 (85428ef)
• dropdown scroll style, fixed #346 (c4d83f2)
• highlight homepage link, fixed #304 (f960c19)
• homepage link (e097f88)
• onlyCover (033be4f)
• ssr compatible embedd (ebc10c4)
• ssr coverpage, fixed #273 (9e824a4)

Features

• click sidebar menu add collapse and expand, close #294 (5e161a1)
• compiler: support embedded file as code block, close #134 (761ccc2)
• compiler: support embedded markdown, html, video, etc files, close #383, close #333 (524f52f)
• cover: add onlyCover option, close #382 (b265fdd)
• fetch: add requestHeaders option, fixed #336 (54ab4c9)
• render: add ext option for custom file extension, close #340 (248aa72)
• render: mutilple coverpage, close #315 (f68ddf5)

4.5.9 (2018-02-07)

Bug Fixes

• upgrade marked (4157173)

4.5.8 (2018-02-07)

Bug Fixes

• cover style, fixed #381 (368754e)
• updated deps (#337) (a12d393)

4.5.7 (2017-12-29)

Features

• add navigation plugin, closed #180 (f78be4c)

4.5.6 (2017-12-14)

Bug Fixes

• style: increase the tap targets of menu button, fixed #325 (888f217)

4.5.5 (2017-11-30)

Bug Fixes

• disqus plugin issue (#318) (041b33e), closes #317

4.5.4 (2017-11-29)

Bug Fixes

• compiler: task lists style, fixed #215 (e43ded4)

Features

• add gitalk plugin (#306) (9208e64)

4.5.3 (2017-11-11)

Features

• add gitalk plugin (#306) (9208e64)

4.5.2 (2017-11-09)

Features

• github task lists, close #215 (#305) (d486eef)

4.5.1 (2017-11-07)

Features

• fetch files with the query params, fixed #303 (2a2ed96)

4.5.0 (2017-11-04)

Features

• add disqus plugin, closed #123 (fd7d4e0)

4.4.1 (2017-10-31)

Bug Fixes

• {docsify-ignore-all} and {docsify-ignore} bug (#299) (cc98f56)
• zoom image plugin issue, fixed #187 (#300) (fa772cf)

4.4.0 (2017-10-30)

Bug Fixes

• sidebar style issue on firefox, fixed #184 (#297) (36bfc9d)

Features

• add helper for disabled link, fixed #295 (#296) (4ad96f3)

4.3.15 (2017-10-20)

Bug Fixes

• scroll active sidebar (a2b8eae)

4.3.14 (2017-10-20)

Bug Fixes

• codesponsor style (ab68268)

4.3.13 (2017-10-17)

Bug Fixes

• duplicate results in search fixed #257 (#284) (3476f6f)

Features

• make whole search result clickable (#285) (1b91227)

4.3.12 (2017-10-15)

Bug Fixes

• incorrect active link (#281) (a3ab379)

4.3.11 (2017-10-15)

Bug Fixes

• broken links to same page heading, fix #278, fix #279 (91d6337)

4.3.10 (2017-10-12)

Bug Fixes

• link render issue after page refreshing (#276) (abd885e)

4.3.9 (2017-10-11)

Bug Fixes

• scroll issue in IE (#275) (3e94cb6)

4.3.8 (2017-10-07)

Bug Fixes

• slugify: GitHub compatible heading links, fixed #272 (9b4e666)

4.3.7 (2017-10-02)

Bug Fixes

• slugify: GitHub compatible heading links, fixed #267 (c195d2d)

4.3.6 (2017-09-21)

Bug Fixes

• style for codesponsor plugin (08afec7)

4.3.5 (2017-09-20)

Bug Fixes

• missed symbol (#254) (6c702d3)

Features

• plugin: add codesponsor plugin (46ac4c3)

4.3.4 (2017-09-07)

Bug Fixes

• scroll position issue, fixed #234 (388ed3d)

4.3.3 (2017-09-06)

Bug Fixes

• buble.css: tweaks code block style, fixed #249 (9d43051)

Features

• add doc for react and vue demo box plugin (#247) (f0aca19)

4.3.2 (2017-09-01)

Bug Fixes

• sidebar highlight (f82f419)

Features

• add Edit on github plugin (thanks @njleonzhang) (a0e1ea8)

4.3.1 (2017-08-30)

Features

• markdown: supports mermaid #137 (f4800e0)

4.3.0 (2017-08-17)

Features

• markdown: supports mermaid #137 (f4800e0)

4.2.9 (2017-08-15)

Bug Fixes

• ensure document ready before init Docsify #233

4.2.8 (2017-08-10)

Features

• compiler: support for setting target attribute for link, fixed #230 (7f270f9)

4.2.7 (2017-08-05)

Bug Fixes

• release: release shell (628e211)
• style: nowrap => pre-wrap, fixed #228 (a88252c)

4.2.6 (2017-07-27)

Bug Fixes

• css: hide the nav when the content has not yet been loaded (1fa1619)
• release: release shell (628e211)

4.2.4 (2017-07-26)

Bug Fixes

• render: Remove getRootNode to be compatible with the lower version of Chrome, fixed #225 (b8dd346)

4.2.3 (2017-07-26)

Features

• search: Supports the max depth of the search headline, fixed #223, resolve #129 (b7b589b)

4.2.2 (2017-07-24)

Bug Fixes

• style rerender due to setting themeColor (17ff3d1)

4.2.1 (2017-07-19)

• give the navbar some line-height (#216)
• Remove unnecessary moduleName option from rollup config for plugins (#209)

4.2.0 (2017-07-10)

Bug Fixes

• not found page (9af8559)

Features

• alias option supports regexp, resolve #183 (c4aa22c)
• ignore to compiled link, fixed #203 (#204) (2e00f4c)

4.1.14 (2017-06-24)

Bug Fixes

• get file path, fixed jrappen/sublime-distractionless/commit/81bfadd391428823191cc03eca956a2312e04d13#commitcomment-22427070 (e8117e5), closes jrappen/sublime-distractionless/commit/81bfadd391428823191cc03eca956a2312e04d13#commitcomment-22427070

Features

• add context attribute, fixed #191 (ce0e9ac)

4.1.13 (2017-06-11)

4.1.12 (2017-06-03)

Bug Fixes

• render: subtitle in side bar shows undefined, fixed #182 (d087d57)

4.1.11 (2017-06-02)

Bug Fixes

• compiler: force reset toc when rendering sidebar fixed #181 (ccf4c7c)
• render: autoHeader does not work (1304d2e)

4.1.10 (2017-06-02)

Bug Fixes

• hash: hash routing crashes when url has querystring (6d48ce1)

4.1.9 (2017-05-31)

Bug Fixes

• can't render toc on first load (d9b487e)
• lifecycle: continue to handle data (955d3d5)
• render: broken name link, fixed #167 (91b66a5)

4.1.8 (2017-05-31)

Bug Fixes

• auto replace version (22b50f0)
• update edit button demo (ec887c1)

Features

• add edit button demo (a64cee1)
• add edit button demo, close #162 (036fdac)

4.1.7 (2017-05-30)

Bug Fixes

• ssr: clean files (0014895)

4.1.6 (2017-05-30)

Bug Fixes

• ssr: add debug (6b9e092)

4.1.5 (2017-05-30)

Bug Fixes

• ssr: missing package (6db8c9e)

4.1.4 (2017-05-30)

Bug Fixes

• ssr: file path (79a83bc)

4.1.3 (2017-05-30)

Bug Fixes

• update babel config (9825db4)

4.1.2 (2017-05-30)

Bug Fixes

• update babel config (80dba19)

4.1.1 (2017-05-30)

Bug Fixes

• build for ssr package (4cb20a5)
• remove history mode (0e74e6c)

4.1.0 (2017-05-30)

4.0.2 (2017-05-30)

Bug Fixes

• basePath for history mode (fc1cd3f)

4.0.1 (2017-05-29)

Bug Fixes

• ssr: remove context (4626157)
• lint (b764b6e)

4.0.0 (2017-05-29)

Bug Fixes

• render: init event in ssr (eba1c98)
• lint (1f4514d)

Features

• finish ssr (3444884)
• init ocsify-server-renderer (6dea685)
• support history mode (f095eb8)