mirror of
https://github.com/docsifyjs/docsify.git
synced 2025-12-08 19:55:52 +00:00
7f0c42eda5
* 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
167 lines
5.6 KiB
HTML
167 lines
5.6 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8" />
|
|
<title>docsify</title>
|
|
<link rel="icon" href="_media/favicon.ico" />
|
|
<meta
|
|
name="google-site-verification"
|
|
content="6t0LoIeFksrjF4c9sqUEsVXiQNxLp2hgoqo0KryT-sE"
|
|
/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
|
|
<meta
|
|
name="keywords"
|
|
content="doc,docs,documentation,gitbook,creator,generator,github,jekyll,github-pages"
|
|
/>
|
|
<meta name="description" content="A magical documentation generator." />
|
|
<meta
|
|
name="viewport"
|
|
content="width=device-width, initial-scale=1.0, minimum-scale=1.0"
|
|
/>
|
|
<link
|
|
rel="stylesheet"
|
|
href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css"
|
|
title="vue"
|
|
/>
|
|
<link
|
|
rel="stylesheet"
|
|
href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/dark.css"
|
|
title="dark"
|
|
disabled
|
|
/>
|
|
<link
|
|
rel="stylesheet"
|
|
href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/buble.css"
|
|
title="buble"
|
|
disabled
|
|
/>
|
|
<link
|
|
rel="stylesheet"
|
|
href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/pure.css"
|
|
title="pure"
|
|
disabled
|
|
/>
|
|
<style>
|
|
nav.app-nav li ul {
|
|
min-width: 100px;
|
|
}
|
|
|
|
#carbonads {
|
|
box-shadow: none !important;
|
|
width: auto !important;
|
|
}
|
|
</style>
|
|
</head>
|
|
|
|
<body>
|
|
<div id="app">Loading ...</div>
|
|
<script>
|
|
window.$docsify = {
|
|
alias: {
|
|
'.*?/awesome':
|
|
'https://raw.githubusercontent.com/docsifyjs/awesome-docsify/master/README.md',
|
|
'.*?/changelog':
|
|
'https://raw.githubusercontent.com/docsifyjs/docsify/master/CHANGELOG.md',
|
|
'/.*/_navbar.md': '/_navbar.md',
|
|
'/zh-cn/(.*)':
|
|
'https://raw.githubusercontent.com/docsifyjs/docs-zh/master/$1',
|
|
'/de-de/(.*)':
|
|
'https://raw.githubusercontent.com/docsifyjs/docs-de/master/$1',
|
|
'/ru-ru/(.*)':
|
|
'https://raw.githubusercontent.com/docsifyjs/docs-ru/master/$1',
|
|
'/es/(.*)':
|
|
'https://raw.githubusercontent.com/docsifyjs/docs-es/master/$1',
|
|
'/write-a-plugin':
|
|
'https://raw.githubusercontent.com/docsifyjs/docsify/master/docs/write-a-plugin.md',
|
|
},
|
|
auto2top: true,
|
|
coverpage: true,
|
|
executeScript: true,
|
|
loadSidebar: true,
|
|
loadNavbar: true,
|
|
mergeNavbar: true,
|
|
maxLevel: 4,
|
|
subMaxLevel: 2,
|
|
ga: 'UA-106147152-1',
|
|
matomo: {
|
|
host: '//matomo.thunderwave.de',
|
|
id: 6,
|
|
},
|
|
name: 'docsify',
|
|
search: {
|
|
noData: {
|
|
'/de-de/': 'Keine Ergebnisse!',
|
|
'/zh-cn/': '没有结果!',
|
|
'/': 'No results!',
|
|
},
|
|
paths: 'auto',
|
|
placeholder: {
|
|
'/de-de/': 'Suche',
|
|
'/zh-cn/': '搜索',
|
|
'/': 'Search',
|
|
},
|
|
},
|
|
plugins: [
|
|
function(hook, vm) {
|
|
hook.beforeEach(function(html) {
|
|
if (/githubusercontent\.com/.test(vm.route.file)) {
|
|
url = vm.route.file
|
|
.replace('raw.githubusercontent.com', 'github.com')
|
|
.replace(/\/master/, '/blob/master');
|
|
} else if (/jsdelivr\.net/.test(vm.route.file)) {
|
|
url = vm.route.file
|
|
.replace('cdn.jsdelivr.net/gh', 'github.com')
|
|
.replace('@master', '/blob/master');
|
|
} else {
|
|
url =
|
|
'https://github.com/docsifyjs/docsify/blob/master/docs/' +
|
|
vm.route.file;
|
|
}
|
|
var editHtml = '[:memo: Edit Document](' + url + ')\n';
|
|
return (
|
|
editHtml +
|
|
html +
|
|
'\n\n----\n\n' +
|
|
'<a href="https://docsify.js.org" target="_blank" style="color: inherit; font-weight: normal; text-decoration: none;">Powered by docsify</a>'
|
|
);
|
|
}),
|
|
hook.afterEach(function(html) {
|
|
if (vm.route.path === '/') {
|
|
return html;
|
|
}
|
|
return `${html}<br/> <i>Vercel</i> has given us a Pro account <br/> <a href="https://vercel.com/?utm_source=docsifyjsdocs" target="_blank"><img src="_media/vercel_logo.svg" alt="Vercel" width="100" height="64"></a>`;
|
|
});
|
|
},
|
|
],
|
|
};
|
|
</script>
|
|
<script src="//cdn.jsdelivr.net/npm/docsify@4/lib/docsify.min.js"></script>
|
|
<script src="//cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.min.js"></script>
|
|
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script>
|
|
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-markdown.min.js"></script>
|
|
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-nginx.min.js"></script>
|
|
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-php.min.js"></script>
|
|
<script src="//cdn.jsdelivr.net/npm/docsify-plugin-carbon@1/index.min.js"></script>
|
|
<script>
|
|
(function() {
|
|
function loadJS(src, attrs) {
|
|
document.write(
|
|
'<script src="' + src + '" ' + (attrs || '') + '><\/script>'
|
|
);
|
|
}
|
|
|
|
// Public site only
|
|
if (/docsify/.test(location.host)) {
|
|
((window.gitter = {}).chat = {}).options = {
|
|
room: 'docsifyjs/Lobby',
|
|
};
|
|
|
|
loadJS('//cdn.jsdelivr.net/npm/docsify@4/lib/plugins/ga.min.js');
|
|
loadJS('//cdn.jsdelivr.net/npm/docsify@4/lib/plugins/matomo.min.js');
|
|
loadJS('//sidecar.gitter.im/dist/sidecar.v1.js', 'async defer');
|
|
}
|
|
})();
|
|
</script>
|
|
</body>
|
|
</html>
|