Commit Graph

513 Commits

Author SHA1 Message Date
Aarav Borthakur
72485a38c1
docs: Add dynamic code block highlighting documentation (#1626) 2021-08-27 18:34:34 +08:00
John Jago
c0bf897ea4 docs: improve English wording (Guide)
This change improves a few of the phrases so that they sound more natural.
Small stylistic changes are also included, such as consistent use of "GitHub"
instead of "Github".
2021-07-30 11:51:24 -05:00
John Jago
97806cb757
docs: improve English wording (Getting Started/Customization) (#1617)
While referencing the documentation, I noticed a few phrases that could
be changed to sound more natural. I tried to keep the original meanings.
2021-07-30 10:18:00 +08:00
沈唁
2840ac5d11
docs: Update docsify-updated to prevent replacement (#1574)
Co-authored-by: Koy <koy@ko8e24.top>
2021-06-26 07:39:56 +08:00
luwol03
ec16e4a9d5
fix: allow also " inside of an embed 2021-06-22 14:31:45 +02:00
wxq
f80846bd4a
docs: src of docsify-copy-code (#1585)
Co-authored-by: 沈唁 <52o@qq52o.cn>
2021-06-04 12:19:03 +08:00
Koy
043c9c9f33
docs: add note on video/media attrs. (#1559)
* docs: add note on video/media attrs.

* update: refine decription.

Co-authored-by: 沈唁 <52o@qq52o.cn>
2021-05-09 09:14:32 +08:00
沈唁
a6fbe079d3
chore: Update Edit Document using develop branch (#1541) 2021-04-18 16:14:33 +08:00
wxq
32203b77bf
docs: link with plugin Pagination (#1554)
Co-authored-by: Koy <koy@ko8e24.top>
2021-04-11 21:02:11 +08:00
沈唁
c2cf163fc0
chore: Fix search for missing pathNamespaces (#1547) 2021-03-28 18:46:09 +08:00
Mitchell Wright
f19dc69aaf
docs:Update deploy, change Zeit to Vercel (#1540) 2021-03-18 00:21:33 +08:00
sy-records
d1b77c7134 [build] 4.12.1 2021-03-07 11:00:41 +08:00
沈唁
a8016c8d74
docs: Update Vercel logo link (#1520) 2021-02-20 15:54:30 +08:00
Mark Battistella
6c13bdb7bd
docs: Updated alias (#1511)
The expression in alias `(+*)` is invalid and a correct working method would be `(.*)`
2021-02-15 09:48:00 +08:00
Koy
065cdd4223
chore: change Gitter to Discord throughout project. (#1507)
* chore: change Gitter to Discord throughout project.
Co-authored-by: 沈唁 <52o@qq52o.cn>
2021-02-13 09:18:54 +08:00
沈唁
f5dd61f538
chore: Fix missing carbon (#1501)
Co-authored-by: John Hildenbiddle <jhildenbiddle@users.noreply.github.com>
2021-02-10 00:03:15 -06:00
John Hildenbiddle
8cda07891a
fix: theme switcher in IE11 (#1502) 2021-02-09 23:27:20 -06:00
John Hildenbiddle
a0f61b2af7
fix: Replace ES6 usage for IE11 compatibility (#1500)
* Remove ES6 syntax for IE11 compatibility

* Replace unsupported methods (IE11)
2021-02-08 23:42:31 -06:00
sy-records
ed4b5be698 [build] 4.12.0 2021-02-08 09:21:40 +08:00
沈唁
8968a744ce
feat: search ignore diacritical marks (#1434)
* feat: search ignore diacritical marks

* Check if normalize is supported

* Update docs

* Fix escape

* remove escapeHtml

Co-authored-by: John Hildenbiddle <jhildenbiddle@users.noreply.github.com>
2021-02-05 13:40:26 +08:00
John Hildenbiddle
7297ee5e10 Add label translations (ru, es) 2021-02-04 14:47:17 -06:00
John Hildenbiddle
9a73bd1ce6 Remove write-a-plugin.md alias 2021-02-04 14:46:07 -06:00
John Hildenbiddle
cf5c7431f1 Set html “lang” attribute based on URL hash
Required to trigger auto-translate feature in applicable Chromium-based browsers (Chrome & Edge)
2021-02-04 14:40:12 -06:00
Koy
85c9c8ffcc
update(docs): update the cmd of python setup serve in py2 and py3. (#1473)
add py3 cmd lines.
2021-01-09 22:11:43 +08:00
John Hildenbiddle
7cf1e7c27a Update Vue-related descriptions and links 2020-11-19 15:42:51 -06:00
John Hildenbiddle
9a1935ac64 Add support for Vue shorthand directive syntax 2020-11-15 13:34:03 -06:00
John Hildenbiddle
a10fcbd9a6 Update Vue-related descriptions 2020-11-12 17:25:48 -06:00
John Hildenbiddle
69efae3c4f Fix typos 2020-11-11 16:27:14 -06:00
John Hildenbiddle
727ee8fc6d Rename vueMountOptions to vueMounts 2020-11-11 16:24:50 -06:00
John Hildenbiddle
421ef1d442 Update docs 2020-11-10 23:24:21 -06:00
John Hildenbiddle
86dae610de Rename vueOptions to vueMountOptions 2020-10-21 13:14:07 -05:00
John Hildenbiddle
1a52e97581 Update docs 2020-10-21 13:03:09 -05:00
John Hildenbiddle
5a2dde1624 Update docs 2020-10-20 17:45:34 -05:00
John Hildenbiddle
019365969d Update docs with new Vue features and usage 2020-10-17 01:50:46 -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
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
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
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
沈唁
0f3211ee77
update doc (#1381)
* update doc

* update
2020-10-03 09:34:17 +08:00
沈唁
b480822286
fix: sidebar horizontal scroll bar (#1362) 2020-08-29 22:23:06 +05:30
sy-records
238dada7a5 [build] 4.11.6 2020-08-22 19:37:00 +08:00
sy-records
dfa5616cfc [build] 4.11.5 2020-08-21 19:15:36 +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
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
沈唁
750663ede4
docs: update other cdn (#1325) 2020-08-02 12:09:08 +08:00
沈唁
2048610aac
fix: {docsify-updated} in the sample code is parsed into time (#1321) 2020-08-01 17:04:08 +08:00
Mattia Astorino
90d283d340
fix: convert {docsify-ignore} and {docsify-ignore-all} to HTML comments (#1318)
* 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>
2020-07-30 18:11:04 +08:00
Bharat Patodi
1a64dc847f
chore: grammatical changes (#1296)
* Make grammatical changes

Minor changes.
Solely for improving readability.

* Update changes

Co-authored-by: 沈唁 <52o@qq52o.cn>
2020-07-26 14:49:02 +05:30
Vladimir Dementyev
d179dde1c7 feat(search): add pathNamespaces option
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)
2020-07-24 11:43:06 +03:00