Commit Graph

1410 Commits

Author SHA1 Message Date
Koy
c9d4f7abc9
fix: the sidebar links to another site. (#1336)
* fix : the sidebar links to another site
2020-10-15 09:13:35 +08:00
沈唁
25bc9b7eb7
fix: Can't search homepage content (#1391)
* fix: Can't search homepage content

* fix: when pathNamespaces does not exist

* add test

* update test to fix windows ci
2020-10-14 12:39:56 +08:00
Snyk bot
ae45b3201b
fix: upgrade debug from 4.1.1 to 4.3.0 (#1390)
Snyk has created this PR to upgrade debug from 4.1.1 to 4.3.0.

See this package in npm:
https://www.npmjs.com/package/debug

See this project in Snyk:
https://app.snyk.io/org/anikethsaha/project/6efe7e04-4e52-497e-8ad5-570733cc577a?utm_source=github&utm_medium=upgrade-pr
2020-10-11 11:50:01 +08:00
Snyk bot
62cd35ee83
fix: packages/docsify-server-renderer/package.json & packages/docsify-server-renderer/package-lock.json to reduce vulnerabilities (#1389)
The following vulnerabilities are fixed with an upgrade:
- https://snyk.io/vuln/SNYK-JS-DOMPURIFY-1016634

Co-authored-by: 沈唁 <52o@qq52o.cn>
2020-10-09 11:26:34 +08:00
John Hildenbiddle
0afbf96701
Fix eslint warnings (#1388) 2020-10-08 21:58:30 -05:00
John Hildenbiddle
761210c2cf
Merge pull request #1271 from docsifyjs/fix-790
Fix Vue Reactivity
2020-10-08 16:05:38 -05:00
沈唁
4f6148db91
Merge branch 'develop' into fix-790 2020-10-08 21:16:58 +08:00
Koy
0ef6aa8ab3
docs: add crossOriginLinks configurations details. (#1386) 2020-10-08 07:00:08 +08:00
John Hildenbiddle
094a503f92 Remove Cypress screenshots 2020-10-07 16:00:04 -05:00
John Hildenbiddle
3a4da88dca Fix friendly message display 2020-10-07 15:39:22 -05:00
John Hildenbiddle
b135f8417d Add Vue 3 compatibility
- Update docs
- Update tests
- Add Vue 2 to docs site
- Add Vue 2 & 3 dependencies for tests
2020-10-07 13:13:03 -05:00
John Hildenbiddle
9b794f5bd1 Show dir listing & help msg for manual instance 2020-10-07 13:10:33 -05:00
John Hildenbiddle
cea9129c11 Add NODE_MODULES_URL global 2020-10-07 13:08:55 -05:00
John Hildenbiddle
78c2a9d7b8 Merge remote-tracking branch 'origin/develop' into fix-790
# Conflicts:
#	cypress/fixtures/tpl/docs.index.html
#	cypress/integration/sidebar/config.spec.js
#	docs/index.html
#	index.html
2020-10-05 14:52:41 -05:00
John Hildenbiddle
474266051c
Merge pull request #1384 from docsifyjs/fix/1383
Fix scroll event end value
2020-10-05 14:27:03 -05:00
John Hildenbiddle
b45f444426
Merge branch 'develop' into fix/1383 2020-10-05 14:21:38 -05:00
John Hildenbiddle
7f0c42eda5
Jest + Playwright Testing (#1276)
* 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
2020-10-05 14:10:30 -05:00
沈唁
e8d3b5e97d
Merge branch 'develop' into fix/1383 2020-10-03 09:40:13 +08:00
沈唁
0f3211ee77
update doc (#1381)
* update doc

* update
2020-10-03 09:34:17 +08:00
John Hildenbiddle
04bf1ea5f4 Fix scroll event end value
Fixes #1383
2020-10-02 14:20:57 -05:00
Snyk bot
c2d12ed27f
fix: upgrade docsify from 4.11.4 to 4.11.6 (#1373)
Snyk has created this PR to upgrade docsify from 4.11.4 to 4.11.6.

See this package in npm:
https://www.npmjs.com/package/docsify

See this project in Snyk:
https://app.snyk.io/org/anikethsaha/project/6efe7e04-4e52-497e-8ad5-570733cc577a?utm_source=github&utm_medium=upgrade-pr
2020-09-13 12:00:50 +08:00
dependabot[bot]
225d551730
chore(deps): bump node-fetch in /packages/docsify-server-renderer (#1370)
Bumps [node-fetch](https://github.com/bitinn/node-fetch) from 2.6.0 to 2.6.1.
- [Release notes](https://github.com/bitinn/node-fetch/releases)
- [Changelog](https://github.com/node-fetch/node-fetch/blob/master/docs/CHANGELOG.md)
- [Commits](https://github.com/bitinn/node-fetch/compare/v2.6.0...v2.6.1)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2020-09-11 11:07:44 +08:00
Koy
14fdbd42ef
test: fix cannot search list content (#1367)
Co-authored-by: 沈唁 <52o@qq52o.cn>
2020-09-04 08:46:43 +08:00
沈唁
8d17dcbe68
fix: cannot search list content (#1361) 2020-09-03 10:34:28 +08:00
沈唁
4807e58cb9
fix: Cannot read property level of undefined (#1357)
Co-authored-by: Anix <anik220798@gmail.com>
2020-09-01 15:04:27 +05:30
Dominik Lubański
f35bf99d9c
fix: add missing argument for highlighting code (#1365) 2020-09-01 13:59:57 +05:30
沈唁
b480822286
fix: sidebar horizontal scroll bar (#1362) 2020-08-29 22:23:06 +05:30
沈唁
9351729634
fix: Cannot read property 'startsWith' of undefined (#1358)
* fix: Cannot read property 'startsWith' of undefined

* Update search.js

* update

* Update search.js
2020-08-28 09:05:47 +08:00
沈唁
2100fc318b
fix: sidebar title error (#1360)
* fix: sidebar title error

* Update sidebar.js
2020-08-27 07:43:07 +08:00
Koy
b353ace7bd
[remove] remove stale bot. (#1352)
remove stale bot.
2020-08-23 10:49:58 +08:00
sy-records
7580dc4185 chore: update changelog 4.11.6 2020-08-22 19:42:40 +08:00
sy-records
d3482aca46 chore: add changelog 4.11.6 2020-08-22 19:37:04 +08:00
sy-records
238dada7a5 [build] 4.11.6 2020-08-22 19:37:00 +08:00
沈唁
ce316075e0
fix : add patch for {docsify-ignore} and {docsify-ignore-all} (#1351)
* revert: Convert {docsify-ignore} and {docsify-ignore-all} to HTML comments

This reverts commit 90d283d340

* fix: patch for docsify-ignore

* fix test

* fix test
2020-08-22 19:24:56 +08:00
Aadhitya A
ef32da1dcf
Fix git commit typo (#1347)
* Refine the git commit steps description.
2020-08-22 11:51:08 +08:00
sy-records
e474ea86d4 chore: add changelog 4.11.5 2020-08-21 19:15:39 +08:00
sy-records
dfa5616cfc [build] 4.11.5 2020-08-21 19:15:36 +08:00
Snyk bot
d439bac93f
fix: packages/docsify-server-renderer/package.json & packages/docsify-server-renderer/package-lock.json to reduce vulnerabilities (#1250)
The following vulnerabilities are fixed with an upgrade:
- https://snyk.io/vuln/SNYK-JS-DOCSIFY-567099

Co-authored-by: 沈唁 <52o@qq52o.cn>
2020-08-21 15:48:15 +08:00
沈唁
1dc754a08b
fix typo (#1345) 2020-08-21 10:42:31 +08:00
沈唁
5037f0b4e6
chore: Remove the src directory from packages.json's files (#1344) 2020-08-20 11:36:45 +05:30
Snyk bot
59d090fe90
fix: upgrade tinydate from 1.2.0 to 1.3.0 (#1341)
Snyk has created this PR to upgrade tinydate from 1.2.0 to 1.3.0.

See this package in npm:
https://www.npmjs.com/package/tinydate

See this project in Snyk:
https://app.snyk.io/org/anikethsaha/project/836f877b-b98e-47ed-89fc-554e9b2e146d?utm_source=github&utm_medium=upgrade-pr
2020-08-18 22:04:44 +08:00
Anix
cc071c56f9
Docs: added carbon ads using docsify-plugin-carbon (#1337)
Co-authored-by: 沈唁 <52o@qq52o.cn>
2020-08-17 20:23:11 +05:30
Koy
13cefa9cf2
Merge pull request #1338 from docsifyjs/snyk-upgrade-7969cf0f96a9957be6302d7d7a5f9666
[Snyk] Upgrade medium-zoom from 1.0.5 to 1.0.6
2020-08-17 21:41:22 +08:00
snyk-bot
3beaa6666b fix: upgrade medium-zoom from 1.0.5 to 1.0.6
Snyk has created this PR to upgrade medium-zoom from 1.0.5 to 1.0.6.

See this package in npm:
https://www.npmjs.com/package/medium-zoom

See this project in Snyk:
https://app.snyk.io/org/anikethsaha/project/836f877b-b98e-47ed-89fc-554e9b2e146d?utm_source=github&utm_medium=upgrade-pr
2020-08-17 08:39:14 +00:00
dependabot[bot]
1dbb547dd7
chore(deps): bump websocket-extensions from 0.1.3 to 0.1.4 (#1205)
Bumps [websocket-extensions](https://github.com/faye/websocket-extensions-node) from 0.1.3 to 0.1.4.
- [Release notes](https://github.com/faye/websocket-extensions-node/releases)
- [Changelog](https://github.com/faye/websocket-extensions-node/blob/master/CHANGELOG.md)
- [Commits](https://github.com/faye/websocket-extensions-node/compare/0.1.3...0.1.4)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2020-08-14 19:02:21 +08:00
Snyk bot
086c2859ad
[Snyk] Security upgrade marked from 0.7.0 to 1.1.1 (#1313)
* fix: package.json & package-lock.json to reduce vulnerabilities

The following vulnerabilities are fixed with an upgrade:
- https://snyk.io/vuln/SNYK-JS-MARKED-584281

* fix: fix CompileError

* fix: embed files error

Co-authored-by: Koy <369491420@qq.com>
Co-authored-by: 沈唁 <52o@qq52o.cn>
2020-08-14 07:53:23 +08:00
dependabot[bot]
f7be0b07fa
chore(deps): bump prismjs from 1.19.0 to 1.21.0 (#1331)
Bumps [prismjs](https://github.com/PrismJS/prism) from 1.19.0 to 1.21.0.
- [Release notes](https://github.com/PrismJS/prism/releases)
- [Changelog](https://github.com/PrismJS/prism/blob/master/CHANGELOG.md)
- [Commits](https://github.com/PrismJS/prism/compare/v1.19.0...v1.21.0)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2020-08-09 07:33:29 +08:00
dependabot[bot]
8fe83cffca
chore(deps): bump prismjs in /packages/docsify-server-renderer (#1332)
Bumps [prismjs](https://github.com/PrismJS/prism) from 1.19.0 to 1.21.0.
- [Release notes](https://github.com/PrismJS/prism/releases)
- [Changelog](https://github.com/PrismJS/prism/blob/master/CHANGELOG.md)
- [Commits](https://github.com/PrismJS/prism/compare/v1.19.0...v1.21.0)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2020-08-09 07:25:38 +08:00
Vladimir Dementyev
2bceabcb8e
fix: fallback page should use path not file location (#1301)
* 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>
2020-08-04 14:47:03 +05:30
沈唁
750663ede4
docs: update other cdn (#1325) 2020-08-02 12:09:08 +08:00