* 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>
- Add detection of Vue HTML directives to trigger mounting
- Fix bug that processed markdown child nodes as global Vue instances even if vueGlobalOptions is not specified
- Fix bug that prevented passing vueGlobalOptions to global instances if `data()` prop did not exist
- Update Vue config check to test for existence of object keys instead of just the existence object
- Update tests
* Initial Jest+Playwright setup
* Fix eslint warnings
* Add placeholder for common options
* Fix load order of scriptURLs
* Add docsifyURL and waitForSelector options
* Add executeScript scenarios
* Enable firefox and webkit tests by default
* Prevent prettier from reformatting browsers list
* Update options and add JSDoc comments
* Initial commit
* Complete initial example tests
* Minor tweaks
* Change suite name
* Rename file
* Add npm script to run jest+playwright example test
* Clean up server properties
* Isolate e2e, integration, and unit test environments
- Setup projects for e2e, integration, and unit tests in Jest configuration
- Setup /tests/e2e/ tests for Jest+PlayWright
- Setup /tests/integration/ tests for Jest
- Setup /tests/unit/ tests for Jest
- Setup eslint for Jest and Jest+Playwright environments
- Move e2e configuration files into separate folder
- Update e2e example tests
- Update unit example tests
- Update HTML fixtures
* Update docsifyInit helper
- Add `debug` option
- Append `Markdown` suffix to markdown-related options
- Reorder options alphabetically
* Add jestPlaywright.debug() to e2e examples
* Removed need to pass page as arg to docsifyInit()
* Add VSCode debug configurations
* Change test server port from 8080 to 3001
* Clean up test names and expect() order
* Update npm scripts to ignore example tests
* Add CLI commands and resources section
* Add Jest unit test snapshot example
* Added Jest unit and e2e tests to Github workflows
* Add npm script to run Jest examples
Added for new devs who are exploring the examples, as the need for passing --testPathIgnorePatterns is not obvious. This flag is required because the example tests are excluded by default.
* Remove node 10.x and add 14.x from tests
Required for jest+playwright testitng
* Temporarily disable testPathIgnorePatterns for ci
* Temporarily remove node 14 from matrix
Cypress fails on node 14.x
* Alternate workflow setup for new test env
* Update workflow platforms and node versions
Also cleaning up naming
* Restoring original workflow names
* Remove Cypress tests
* Remove/Reset GitHub actions
* Restore/reset workflows
* Bump actions/checkout@v1 to v2
* Use playright GH action
* Update playwright GH action configuration
* Remove unnecessary steps and update checkout version
* Add install step
* Add --ignore-scripts flag
Linting does not require running scripts automatically executred after install.
* Swicth from ci to i for install
* Add new Build & Test workflow
* Add OS tests
* Wait for network idle for more reliable ready state
* Configure image snapshot testing and add example
* Remove example fixture file
* Adjust image snapshot threshold for local & CI tests
* Upload diff-output artifact
* Add failure() check to upload-artifact
* Bump image snapshot threshold for local & CI tests
* Set diffDirection
* Fix XHR caching in playwright tests
* Update image snapshot example and theshold
* Bump image snapshot threshold for local & CI tests
* Remove old workflows
* Bump image snapshot threshold for local & CI tests
* Bump image snapshot failureThreshold for local & CI tests
* Set failureThresholdType to percent
* Change image snapshot comparisonMethod to ssim
* Remove pixelMatch options (incompatible with ssim)
* Bump image snapshot failureThreshold
* Bump image snapshot failureThreshold
* Disable fast-fail to allow all checks to complete
* Rename workflow
* Disable fast-fail to allow all checks to complete
* Store pixel and ssim comparison configs
* Add link to image snapshot test
* Fix CI errors on Windows due to image size mismatch
* Attempt to fix macos e2e exit code 134 issue
* Update test.yml
* Update test.yml
* Update test.yml
* Fix --ci flag
* Set Jets to use --runInBand for macOS e2e
* Remove unnecessary macOS check
* Set image snapshot to runInProcess (macOS CI fix)
* Update test.yml
* Temporary failureThreshold change for debugging
* Upload os+node-specific diff artifacts
* Remove node version from diff artifact
* Revert "Remove node version from diff artifact"
This reverts commit 9cfcc4342bb22f18da30363a4c52758f13ba0cc9.
* Revert "Revert "Remove node version from diff artifact""
This reverts commit ad6c1891e48c70c9973a5c0d7b876b2d4621f3b9.
* Restoring failureThreshold after debugging
* Remove runInProcess option
* Revert "Remove runInProcess option"
This reverts commit 667ed6c870fc56f0349fc5eccc2cdeead3eff4ea.
* Add node-specific artifact uploads
* Set ssim mode to fast and restore runInProcess
* Set failureThreshold to 0.01
* Updating to playwright@next for webkit fix
* Restore optimal ssim configuration
* Testing pixel vs. ssim image comparison
* Move shared test setup to unit/int/e2e setups
* Refactor test server setup
* Replace live-server with browser-sync
* Update script for running local docs site
- Only init GA plugin on public site
- Only init Gitter plugin on public site
- Only init Matomo plugin on public site
NOTE: Large diff is a result of initial Prettier formatting. Actual change limited to last <script> block on page.
* Allow launching test server preview with --start
* Add integration tests and refactor unit + e2e
* Unify docsifyInit() and cleanup
- Create unified docsifyInit() for jest and playwright
- Move shared helpers to /tests/helpers
- Update tests
- Update globals
* Fixed webkit routes by specifying ContentType
* Update snapshot
* Update dependencies
* Update tests to use unified docsifyInit()
* Remove Cypress (old e2e test environment)
* Update tests to run (unit/integration/e2e)
- Add new integration tests (Jest)
- Remove old unit tests (mocha+jsdom)
- Remove old e2e tests (Cypress)
* Remove Cypress-related dependency
* Remove mocha+chai+jsdom (old unit/int test env)
* Rename testing directories and scripts
- Rename /tests/ directory to /test/
- Rename script/task names by removing “jest” identifier
- Remove “test:jest-examples” script
* - Configure test server for availability with all tests (previously e2e only)
- Create identical docsifyInit() tests using Jest (integration) and Playwright (e2e)
- Update docsifyInit() to convert relative URLs to absolute URLs to work in both JSDOM and Playwright
- Update docsifyInit() to append style- and js-related tags using createElement instead of insertAdjacentHTML
- Update paths in test files to use unified docsifyInit()
- Added option to docsifyInit() to enable/disable formatted HTML output to console
- Removed vue.css as default docsify theme from docsifyInit()
- Removed outdated files
* Reorganize test files
* Fix basePath option
* Replace do-mock-ajax with xhr-mock
- Allows mocking all XMLHttpRequests instead of just those initiated via /src/core/fetch/ajax.js
- Allows JSDOM tests to use /lib/docsify.js instead of /src/core/index.js (same as Playwright tests)
- Allows JSDOM tests to use /docs site as test content
* Added new waitFor helpers
* Clean up globals
- Import globals from various files instead of manually adding them to ensure they are availability in Jest and eslint configurations
- Add middleware to server configuration for serving virtual “_blank.html” file
- Add BLANK_URL
- Rename TEST_URL to TEST_HOST
- Removed ./test/fixtures/ directory (blank page now served via server.js middleware)
- Added page.goto(BLANK_URL) call to global Playwright beforeEach() setup
* Add try/catch for waitForFunction callback
* Move playwright config into jest.config.js
* Add runInBand option to tests for reliability
* Remove unnecessary XHR Mock teardown
* Add —runInBand to test script
* Merge develop
* Cleanup
- Relocate carbon plugin script with other scripts
- Update zh-cn docs URL to align with other translatins (GitHub, not jsdelivr)
- Add major version locks to URLs
* Removed fixed host value from docs
* Updated test after merge (docsify version change)
* Added startPath for manual instance
* Remove Node 10 from CI tests
* Remove Node 10 from CI lint tests
* revert: Convert {docsify-ignore} and {docsify-ignore-all} to HTML comments
This reverts commit 90d283d340502456a5d8495df596bb4a02ceb39b
* fix: patch for docsify-ignore
* fix test
* fix test
* fix: fallback page should use path not file location
When resolving fallback page for the path (`fallbackLanguages` option), we should consider the original path, not the file location (which could be different when aliases are used).
* fix: use router.getFile to resolve fallback url
* specs: add cypress test for fallbackLanguages
Co-authored-by: 沈唁 <52o@qq52o.cn>
* breaking: convert {docsify-ignore} and {docsify-ignore-all} to HTML comments
Close https://github.com/docsifyjs/docsify/issues/441
* chore: add ignore and ignore-all unit tests
Co-authored-by: 沈唁 <52o@qq52o.cn>
This option allows to dynamically choose the index path depending on the path prefixes in auto mode. Thus, different path namespace could avoid index intersection (e.g., when having multiple locales)
* Fix search plugin will replace matching text
* Fix bug that will replace a unexpected text
* Fix bug that will replace a unexpected text
* Optimized
Co-authored-by: 沈唁 <52o@qq52o.cn>
