Skip to content

documente/documente

Repository files navigation

Logo for the Documenté literate testing framework

Welcome to Documenté

The Javascript literate testing framework

Visit Documenté's website for an overview of the framework!

Repository overview

This monorepository contains the core components of the Documenté framework.

Package name Description
generator Extracts Phrasé tests from documentation files and generate test cases
kitchen-sink A static website with Documenté configuration showcasing the API
minimal-example An example of a Documenté configuration to run tests against example.com
phrase The Phrasé language parser
runner-cypress Test runner for Cypress
runner-playwright Test runner for Playwright

Getting started

See the Getting Started guide.

Contributing

Any contributions you make are greatly appreciated.

For suggestions and improvements, feel free to fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Don't forget to give the project a star! Thanks again!

License

Distributed under the GNU GPL3 License.

See LICENSE for more information.

Contact

Pierre-Clément KERNEIS - pc.kerneis@gmail.com

Project Link: https://github.com/documente