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)
* 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
- Replace live-server with existing Browsersync dependency as web server
- Remove duplicate `index.html` file
- Add `build:html` script to generate `/docs/preview.html`
* Add response data to route object
* Display error status and description on content fetch error
* Fix issue where initial site render was incomplete on content fetch error
* Fix issue where empty markdown pages/routes were handled as 404 errors
* Fix incorrect `notFoundPage` default value
BREAKING: In a minority of cases syntax updates may break apps running in very old browsers (such as Internet Explorer), or apps that build Docsify in a custom way with old build tools. To upgrade, build Docsify for older browsers in a custom way, or update existing build tools to handle newer syntax.
DEPRECATED: `$docsify.themeColor` is deprecated and will be eventually removed, use a `--theme-color` CSS variable in your style sheet.
BREAKING: The new project layout might break in some tooling setups.
We've added an exports field to `package.json` to specify where
statements like `import ... from 'docsify'` will import from, and left
the `main` and `unpkg` fields as-is for backwards compatibility with the
global <script> import method. Most people who use a non-module
`<script>` tag to import Docsify will not notice a difference. Anyone
else who is importing Docsify into a specilized build setup using
`import` statements has a chance of being broken, so we've marked this
as BREAKING.
* add first test
* new VirtualRoutes mixin that handles routes. fetch tries to use VirtualRoutes. default config updated
* cover all basic use cases
* regex matching in routes
* covered all virtual routes tests
* added hack to fix config test on firefox
* removed formatting regex matches into string routes
* added support for "next" function
* added docs
* navigate now supports both hash and history routerModes
* waiting for networkidle in navigateToRoute helper
* promiseless implementation
* remove firefox workaround from catchPluginErrors test, since we no longer use promises
* updated docs
* updated docs for "alias" as well
* minor rephrasing
* removed non-legacy code from exact-match; updated navigateToRoute helper to infer router mode from page
* moved endsWith from router utils to general utils; added startsWith util; refactored makeExactMatcher to use both
* updated docs per feedback
* moved navigateToRoute helper into the virtual-routes test file
* moved navigateToRoute to top of file
* updated docs per pr comments
* Update test environments and lint configuration
Update Jest (unit + integration) and Playwright (e2e) test environments. Includes stability improvements for e2e tests using newer, more stable methods per the Playwright docs.
- Update Jest 26 => 27
- Update Jest-related libs (babel parser)
- Update Playwright 1.8 => Playwright Test 1.18
- Update GitHub CI (action versions, job parallelization, and matrices)
- Update ESLint 5 => 8
- Update ESLint-related libs (parser, prettier, Jest, Playwright)
- Fix test failures on M1-based Macs
- Fix e2e stability issues by replacing PW $ method calls
- Fix ESLint errors
- Fix incorrect CI flag on Jest runs (-ci => --ci)
- Refactor e2e test runner from Jest to Playwright Test
- Refactor e2e test files for Playwright Test
- Refactor fix-lint script name to lint:fix for consistency
- Refactor npm scripts order for readability
- Remove unnecessary configs and libs
- Remove example image snapshots
* Fix: Cannot serve off `/.../index.html`
Docsify must be hosted on a server that supports a default directory
index (i.e. maps `/.../` -> `/.../index.html`).
Some platforms do not support this, however. For example, HTML apps
hosted on the popular game/software platform, Itch.io.
This change supports hosting Docsify off an explicit path file, such as
`/index.html`. It does this by:
1. Adding handling for paths like `index.html#/blah`, and
2. Normalising paths with fragments back to markdown paths
For example, `http://example.org/index.html#/blah` would be mapped to
`http://example.org/blah.md`.
This fixes:
https://github.com/docsifyjs/docsify/issues/427
* Add end-to-end test for index file hosting
* Add code comments for explicit file changes
* Add additional tests for index file hosting
* Add additional tests for index file hosting
* [wip] Attempt to switch tests to Jest
* Add e2e test for new Jest test framework
* Verify sidebar links use file hosting
* Fix: endsWith() not supported for IE11
* Refactor: utility method moved to utility file
* Fix IE11 error from use of String.includes()
Co-authored-by: John Hildenbiddle <jhildenbiddle@users.noreply.github.com>
* fix: duplicate search content when `/readme` or `/` exists in the sidebar
* Update
* add test
* Reset local storage before each e2e test
* Reset Playwright context instead of page
* Update playwright dependencies
Co-authored-by: John Hildenbiddle <john@hildenbiddle.com>
hhang