* chore: add missing Vue support for Vercel builds
* refactor: move some functions and module-level state into classes as private methods and properties to start to encapsulate Docsify
Also some small tweaks:
- move initGlobalAPI out of Docsify.js to start to encapsulate Docsify
- move ajax to utils folder
- fix some type definitions and improve content in some JSDoc comments
- use concise class field syntax
- consolidate duplicate docsify-ignore comment removal code
This handles a task in [Simplify and modernize Docsify](https://github.com/docsifyjs/docsify/issues/2104), as well as works towards [Encapsulating Docsify](https://github.com/docsifyjs/docsify/issues/2135).
* chore: add prettier code format check to our lint script, and add a prettier script for manually formatting the whole code base
* chore: update issue/pr templates
* chore: apply our format to the whole code base
---------
Co-authored-by: Koy <koy@ko8e24.top>
Co-authored-by: i544693 <369491420@qq.com>
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.
Co-authored-by: Joe Pea <joe@trusktr.io>
Co-authored-by: 沈唁 <52o@qq52o.cn>
Co-authored-by: John Hildenbiddle <jhildenbiddle@users.noreply.github.com>
Co-authored-by: zhanzhao <zhanzhao@megvii.com>
BREAKING: SSR removed
Anyone depending on SSR will need to stay on an old Docsify version for
now, move forward without SSR, or maintain SSR against a fork of updated
Docsify. We have ideas on a better way to implement SSR, but these ideas
have not been implemented yet.
* fix: Ignore emoji shorthand codes in URIs
Fixes: #1823
* test: Add test for emoji in anchor body
* fix: Handle support for URIs used in additional contexts
Examples:
- Without explicit scheme (i.e. starting with `//`)
- In single and double quote strings
- Within unquoted HTML tag attributes
- In css `url()` values
Co-authored-by: John Hildenbiddle <jhildenbiddle@users.noreply.github.com>
* 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>
