diff --git a/tests/helpers/docsifyInit.js b/tests/helpers/docsifyInit.js index 68d24e24..8299b3b1 100644 --- a/tests/helpers/docsifyInit.js +++ b/tests/helpers/docsifyInit.js @@ -1,6 +1,25 @@ const stripIndent = require('common-tags/lib/stripIndent'); const { serverIP, serverPort } = require('./server.js'); +/** + * Playwright helper for dynamically creating custom docsify sites. + * + * @param {Object} page Playwright page reference + * @param {Object} options options object + * @param {Object} [options.config] docsify configuration (merged with default) + * @param {String} [options.content] homepage markdown + * @param {String} [options.coverpage] coverpage markdown + * @param {String} [options.navbar] navbar markdown + * @param {String} [options.sidebar] sidebar markdown + * @param {Array[]|Array[][]} [options.routes] custom routes as [path, response] (See https://playwright.dev/#path=docs%2Fapi.md&q=routefulfillresponse for details) + * @param {String} [options.style] CSS to inject via