https://github.com/dotnetprofessional/livedoc

A Living Documentation platform for BDD (Gherkin) specifications.
https://github.com/dotnetprofessional/livedoc

bdd cucumber gherkin javascript livedoc livedoc-mocha living-documentation mocha typescript

Last synced: 8 days ago
JSON representation

A Living Documentation platform for BDD (Gherkin) specifications.

• Host: GitHub
• URL: https://github.com/dotnetprofessional/livedoc
• Owner: dotnetprofessional
• License: mit
• Created: 2014-04-19T07:30:45.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2023-01-12T08:23:59.000Z (about 2 years ago)
• Last Synced: 2024-04-14T15:25:27.695Z (10 months ago)
• Topics: bdd, cucumber, gherkin, javascript, livedoc, livedoc-mocha, living-documentation, mocha, typescript
• Language: TypeScript
• Homepage:
• Size: 6.72 MB
• Stars: 8
• Watchers: 4
• Forks: 2
• Open Issues: 36
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![logo](artwork/logo-small.png)

# LiveDoc

A Living Documentation platform for BDD projects using a javascript/typescript testing library. The project is made up of two parts:

* __Part I:__ A Gherkin language extension for [mochajs](mochajs.org). The mocha extension can be found here: [livedoc-mocha](packages/livedoc-mocha#readme).

![Mocha Test Result](packages/livedoc-mocha/docs/images/livedoc-spec-default.PNG)

* __Part II:__ provide a reporting tools for displaying the output of the specifications. This phase is where we take the test output in Gherkin and make it usable as Living Documentation. The idea is to make navigation and discovery of the specifications easy and insightful. Today [livedoc-mocha](packages/livedoc-mocha/docs/JSON-Reporter.md) provides the ability to export a rich `json` file to build custom reports.