Commit Graph

610 Commits

Author SHA1 Message Date
Luffy 18b03e49fa fix: correct grammar in 'Edit on github' section of plugins.md 2026-04-29 10:11:54 +08:00
Luffy ee6fef4ffc fix: implement normalize method in html5.js (#2712) 2026-04-04 10:35:26 +08:00
Luffy f3ab502555 feat: add pageTitleFormatter config (#2695) 2026-03-23 10:54:30 +08:00
Luffy b43d1c7d5c docs: remove Matomo plugin and update embedded website link (#2696) 2026-03-18 10:45:54 +08:00
Luffy c8f93ff3fc [release] 5.0.0-rc.4 2026-03-11 11:44:14 +08:00
cinwell.li f4c37e0ada docs: change embedded website link to Google
Updated the embedded link from cinwell.com to google.com.
2026-03-04 20:13:50 +08:00
Joe Pea 7e29ca092f chore: Build and publish v4 lib/ and themes/ folders for backwards compatibility while users transition to v5. (#2667)
* Build and publish v4 lib/ and themes/ folders for backwards compatibility while users transition to v5.

- add a script to build the legacy v4 lib/ and themes/ folders
- append deprecation console warnings to the v4 JS files during the v4 build
- add a script to clean v4 build outputs
- hook the v4 build/clean scripts into the release.sh script
- test the v4 build and clean in CI

* fix: update repository field format in package.json

---------

Co-authored-by: Luffy <52o@qq52o.cn>
2026-02-05 15:38:39 +08:00
Paul Hibbitts 🍁 37a2559110 docs: Add v5 upgrade docs (#2665)
Co-authored-by: Luffy <52o@qq52o.cn>
2026-01-15 10:23:56 +08:00
Jake 29ed7810fc docs: Improve embed files code fragment (#2650) 2026-01-08 00:34:39 +08:00
Joe Pea b960519608 feat: output type definitions, and allow new Docsify(opts) to accept options for ESM usage (#2392)
This `new Docsify(opts)` API can be safely converted to a Custom Element constructor with backwards compatibility later.
2025-12-03 21:49:44 -08:00
Jake e8117563ea feat: Fragment identifier full line ignore (#2626) 2025-11-24 10:47:19 +08:00
Marta Karaś 8016f8f35c docs: add DeployHQ deployment instructions (#2627) 2025-11-13 10:31:07 +08:00
Luffy 1abe3a9ea4 feat: add fallback default language support (#2607) 2025-10-15 17:46:51 +08:00
Paul Hibbitts 🍁 8fe0e1c0f1 docs: Update intro paragraph to help improve first impressions and broaden audience (#2602)
Co-authored-by: Luffy <lufei@docsifyjs.org>
2025-09-28 10:43:05 +08:00
Luffy 1ad5763216 [release] 5.0.0-rc.3 2025-09-05 12:24:11 +08:00
Luffy 400ecbc813 [release] 5.0.0-rc.2 2025-09-05 12:19:04 +08:00
Luffy 5999f09a4b fix: normalize slugs to NFC and remove emoji variation selector (#2597) 2025-09-02 11:46:11 +08:00
John Hildenbiddle 2e59b0f50c feat: GitHub style callouts (#2487)
Co-authored-by: Koy Zhuang <koy@ko8e24.top>
Co-authored-by: Luffy <52o@qq52o.cn>
2025-09-01 12:53:59 +08:00
Luffy 22ac7e855d fix: enhance focus handling (#2595) 2025-08-21 16:12:56 +08:00
Luffy 4c9e1117ba docs: remove loading dialog section from quickstart guide (#2585) 2025-08-07 10:32:22 +08:00
Paul Hibbitts 🍁 5448d93b4d docs: Included relevant CSS vars to theme docs. (#2592)
Co-authored-by: Luffy <52o@qq52o.cn>
2025-08-06 11:01:52 +08:00
Luffy b468bcd677 refactor: simplify auto header insertion logic (#2578) 2025-08-02 15:15:36 +08:00
Waldir Pimenta c9301b0c9d docs: Improve Quick start instructions (#1466)
Co-authored-by: Luffy <lufei@docsifyjs.org>
2025-07-30 14:50:35 +08:00
Luffy 5a49729afb docs: update sidebar link formatting (#2577) 2025-07-28 22:46:27 +08:00
Luffy 72569dee8d fix: handle hash navigation to prevent duplicate callbacks (#2575) 2025-07-24 11:00:20 +08:00
Koy Zhuang a2f734f223 feat: support config helper multi keys if supported (#2571)
* update: support config helper multi keys

---------

Co-authored-by: Luffy <lufei@docsifyjs.org>
2025-07-22 12:24:06 +08:00
Luffy 8d41cbed7b [release] 5.0.0-rc.1 2025-05-27 10:36:20 +08:00
sy-records 5b4b435211 chore: update CDN links to use the correct path for Docsify themes 2025-05-26 20:43:18 +08:00
Luffy f0b03f6d98 chore: add depth configuration for search (#2549)
There is h6 content in the document, but the search configuration defaults to h2, so the relevant content is not searched.
2025-05-12 09:37:24 +08:00
Luffy ccb7515b70 docs: remove test pwa 2025-05-09 14:41:11 +08:00
Luffy f6ed6d3f89 docs: changes in sync Chinese translation (#2548) 2025-05-08 15:43:44 +08:00
Luffy 5d9ea4f664 update: correct links and action to 'main' branch (#2547) 2025-05-06 17:19:25 +08:00
Luffy 41fd8f624e chore: remove sponsors section (#2544)
* chore: Remove Gold sponsors section

Because they don't sponsor us anymore.

* chore: Remove route4me logo

---------

Co-authored-by: Koy Zhuang <koy@ko8e24.top>
2025-05-06 17:12:42 +08:00
Luffy 2e587a22e4 chore: retire outdate multiple languages and update it test snap (#2546) 2025-05-06 17:08:57 +08:00
Luffy 2d090efa68 Merge remote-tracking branch 'upstream/master' into develop 2025-05-06 15:07:17 +08:00
Luffy e1d4c189e3 chore: Sync emoji data with GitHub emoji API (#2539) 2025-04-19 08:37:28 +08:00
Eze Amaka 32fff4a99a docs: Update Netlify deployment (#1781) 2024-12-16 14:06:11 +08:00
Maciek Palmowski 38944bd41f docs: adds deployment to Kinsta Static Site Hosting (#2299)
Co-authored-by: Koy Zhuang <koy@ko8e24.top>
2024-09-21 19:54:31 +08:00
Koy Zhuang e204ac669d docs: correct mermaid docs after upgrade marked (#2490)
---------

Co-authored-by: Luffy <52o@qq52o.cn>
2024-08-18 20:18:41 +08:00
Luffy 676f5f8842 docs: Add Gold sponsors (#2485) 2024-08-08 13:47:37 +08:00
Koy Zhuang 33f1d9a9d4 docs: correct docs wrong link for adding pages (#2479) 2024-08-01 10:45:36 +08:00
Akshay Bhinge 1e9d2f0036 docs: Removal of flags for language choice drop-down (#2468) 2024-07-20 09:28:31 +08:00
John Hildenbiddle 77d93fae78 feat: v5 style overhaul (#2469)
Style updates:

- New "core" theme serves as base for all other themes (official and third-party)
- New CSS custom properties for simplified customization of "core" theme
  **Note:** List of available properties will be made available in documentation by embedding soruce CSS in docs after merge. Merge is required because embedded CSS needs to be in `main` branch. For now, see `_vars.css` and `_vars-advanced.css` for details.
- New theme "add-ons" modify core theme properties and/or add custom declarations as needed.
- New Prism.js theme support
- New configurable sidebar toggle design
- New typography defaults to system sans-serif and monospace fonts instead of relying on external web font.
- New "Core Dark" theme addon provide dark theme styles. Can optionally be applied based on operating system's light/dark setting using `@media` attribute on `<link>` element.
- New "Vue" theme addon. Closely replicated popular v4 theme while allowing for v5 enhancements.
- New CSS class names available for adding loading indicators, adding sidebar expand/collapse icons, adding sidebar group styles, clamping sidebar links to a single line with ellipses, and changing the sidebar toggle icon.
- New auto-generated gradient background for cover page (ensure gradient hue is > 50 degree apart, use OKLCH color if supported, randomize grandient angle, reduce brightness in dark mode)
- New button styles (basic, primary, secondary)
- New form element styles (text input, radio, checkbox, )
- New "callouts" (previously "important" and "tip" helpers)
- New default syntax highlighting theme (from [docsify-themeable](https://jhildenbiddle.github.io/docsify-themeable/))
- New auto-generated theme color shade and tint colors
- New auto-generated monochromatic color palette
- New form element styles (fields, legend, text input, text area, checkbox, radio, toggles, and select)
- New "headerless" tables
- New `kbd` styles
- New task list style
- New merged navbar styles (consistent with sidebar nav styles)
- New search plugin styles and keyboard shortcut indicators
- Add ability restore previously focused content element after hiding sidebar
- Add "focus trap" when sidebar is visible on mobile (accessibility)
- Add ability for sidebar links to wrap by default (previous single-line w/ ellipsis display available as CSS class on `<body>` option)
- Add sidebar `page-link`, `group`, and `group-title` CSS classes to sidebar markup.
- Add reduced motion media query to set all animation/transition timings to zero
- Update Google Font imports (use new variable vs older fixed width fonts)
- Update primary/secondary button order on coverpage (primary should be first)
- Fix missing merged navbar when loading at desktop resolution then resizing to mobile
- Fix inverted open/close sidebar visibility state at desktop/mobile resolutions
- Fix overflow setting to prevent clipping of element focus ring
- Fix safe area inset margins on mobile in landscape orientation
- Fix inverted "tip" and "warn" class names
- Fix scroll padding to prevent headers from touching top edge of viewport when scrolled to
- Remove Stylus dependency (now using only PostCSS)
- Remove legacy themes "Buble", "Dark", "Dolphin", and "Pure".

Documentation updates:

- New "UI Kit" page showcasing all elements styled by Docsify
- Update "Quick Start" page template
- Update "Adding pages" page with information on how to properly create sidebar group titles and navbar drop-down menus
- Update "Themes" page with theme and class toggles
- Update "Configuration" page with deprecation warnings for `themeColor` and `topMargin`
- Move "Edit Page" link to footer
- Remove [docsify-themeable](https://jhildenbiddle.github.io/docsify-themeable/) endorsement (currently not compatible with v5 and future is unknown)

Miscellaneous updates:

- New search plugin options: `insertBefore` and `insertAfter`
- Add PostCSS config file
- Update BrowserSync config (disable "ghost" mode)
- Update tests
- Fix Jest + Prettier 3 conflict
- Fix `getAndRemoveDocisfyIgnoreConfig` name type (now `Docisfy` => `Docsify`)
- Fix execution of sidebar-generating code when `hiddenSidebar` is `true`
- Remove `inBrowser` constant (SSR deprecated, so no longer needed)
2024-07-19 15:34:51 +00:00
John Hildenbiddle f5412dc7b0 chore: Update lint configuration (ESLint 9, Prettier 3) (#2438)
* Update linting configuration (eslint, prettier)

* Fix lint issues following eslint prettier update

* Change ESLint config to allow boolean coercion

* Switch to default import name per docs

* Fix suppression of error details

* Update JSDoc comments

* Update waiForFunctin to provide error details

---------

Co-authored-by: Koy Zhuang <koy@ko8e24.top>
2024-05-28 15:27:29 -05:00
John Hildenbiddle 4ae87bb18b build: v5 updates and refactors (#2428)
* Update JS build

- Change rollup build from API to config file
- Change output dir from lib to dist
- Update lib to dist path in related files
- Update dependencies
- Add banner comment to bundles
- Add unminified plugin bundles

* Update docs with v5 version lock and dist path

* Update docs to reference minified themes

* Clean up docs

* Update CSS build

- Change CSS build from API to CLI
- Change output dir from lib to dist
- Update lib to dist path in related files
- Update dependencies
- Add sourcemaps

* Update dependencies

* Clean up package.json and add keywords

* Fix rimraf globs on Windows

* Fix PostCSS CLI glob on Windows

* Update test-related dependencies

* Update emoji

* Add engines prop to package.json
2024-05-21 15:19:21 -05:00
John Hildenbiddle 8ef9a3cd03 Fix: Vue text interpolation in code blocks. (#2430)
* Update Vue 3 depenency and docs. Remove Vue 2.

* Fix minor lint issue

* Remove Vue 2 reference

* Swap button positions

* Update Vue2 links

* Send HTML with _blank to avoid quirks mode

* Support Vue text interpolation in code blocks

Fix #1812
2024-05-19 11:49:33 -05:00
timothyjohn2015 0070e26da5 docs: Fix spelling mistake (#2426) 2024-05-13 09:43:33 +08:00
Can Eldem 11015feecc docs: add stormkit as deployment platform (#2413) 2024-05-07 08:11:41 +08:00
Luffy 87fd55d712 fix: carbon broken (#2387) 2024-03-26 08:19:31 +08:00
Bingzhi.Li 9e681c6419 chore: fix front matter broken (#2390)
Co-authored-by: Luffy <52o@qq52o.cn>
2024-03-22 09:37:28 +08:00