Skip to content

Latest commit

 

History

History
 
 

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
_data
_data
 
 
_includes
_includes
 
 
api
api
 
 
assets
assets
 
 
CONTRIBUTING.md
CONTRIBUTING.md
 
 
README.md
README.md
 
 
assertions.md
assertions.md
 
 
configuring_taiko.md
configuring_taiko.md
 
 
experimental_features.md
experimental_features.md
 
 
file_upload_and_download.md
file_upload_and_download.md
 
 
frequently_asked_questions.md
frequently_asked_questions.md
 
 
getting_help.md
getting_help.md
 
 
index.html
index.html
 
 
installing.md
installing.md
 
 
integrating_with_test_runners.md
integrating_with_test_runners.md
 
 
overview.md
overview.md
 
 
package-lock.json
package-lock.json
 
 
plugins.md
plugins.md
 
 
record_and_run_tests.md
record_and_run_tests.md
 
 
running_scripts_inside_the_browser.md
running_scripts_inside_the_browser.md
 
 
taiko_in_docker.md
taiko_in_docker.md
 
 
taking_screenshots.md
taking_screenshots.md
 
 
writing_plugins.md
writing_plugins.md
 
 

README.md

Building the website

npm run doc

Preview and Develop

npm run doc:serve

How the website generation works

When you run npm run doc this does two steps:

  1. Run documentation.js to generate a JSON representation of the JSDoc comments
  2. Run eleventy to generate HTML for the documentation website.

Step 1 - Generating the JSON

This steps uses the documentation.js library to parse the JSDoc comments in the code and generate a JSON file name lib/api.json.

The chain is the following:

  • you digit npm run doc
  • As a first step this runs npm run doc:api
  • Which launches lib/documentation.js
  • Which in turn checks the environment variable TAIKO_SKIP_DOCUMENTATION, if false it launches npx documentation build --shallow lib/taiko.js lib/elementWrapper/*.js -o lib/api.json

This is the same as running the following command in the terminal:

npx documentation build --shallow lib/taiko.js lib/elementWrapper/*.js -o lib/api.json

At the time of writing, only JSDoc comments in taiko.js and the files in the directory of elementWrapper are parsed:

  • taiko.js contains the definition of the APIs for external use
  • lib/elementWrapper/*.js contains the definition of some classes (ElementWrapper and company) which are used as return type for api's functions

Step 2 - Generating the web site

The second step uses eleventy to generate the web site. There is a .eleventy.js file in the project's root dir which configures the tool and in particular sets:

  • input: './docs',
  • output: './docs/_site'

Eleventy takes the input folder, which mainly contains markdown files and converts everything to html.

Additionally there is a folder named docs/api which has templates built with nunjucks:

  • class.njk
  • api.njk
  • reference.njk

Those templates are converted to HTML from data provided by two functions:

  • docs/_data/apis.js which basically reads the the data from lib/api.json produced in step 1, and divides them in:
    • classes which are processed with the class.njk template
    • functions which are procesed with the api.njk template
  • docs/_data/metadata.js which basically reads the variable metadata from lib/taiko.js, this variable contains the table of contents for the page API Reference and it is processed with reference.njk template