https://github.com/carmenmitru/wdio-markdown-reporter

WebdriverIO plugin for Markdown report
https://github.com/carmenmitru/wdio-markdown-reporter

Last synced: 2 months ago
JSON representation

WebdriverIO plugin for Markdown report

• Host: GitHub
• URL: https://github.com/carmenmitru/wdio-markdown-reporter
• Owner: carmenmitru
• Created: 2019-12-26T09:09:02.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2019-12-26T15:12:27.000Z (about 5 years ago)
• Last Synced: 2024-11-14T05:08:24.087Z (2 months ago)
• Language: JavaScript
• Size: 113 KB
• Stars: 2
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-webdriverio - Markdown - Report results in Markdown format. (Plugins / Reporters)

README

        
# WebdriverIO Markdown Reporter

> A WebdriverIO plugin to report in Markdown style.

![Reporter](./img/reporter.png)

## Installation

You can simple do it by:

```bash

npm install wdio-markdown-reporter --save-dev

```

Instructions on how to install `WebdriverIO` can be found [here.](https://webdriver.io/docs/gettingstarted.html)

## Configuration

At the top of the wdio.conf.js-file, add:

```js

// wdio.conf.js

var markdownReporter = require("wdio-markdown-reporter");

```

In order to use the service you need to add reporter to your services array in wdio.conf.js

```js

// wdio.conf.js

export.config = {

  reporter: : [

    [markdownReporter, {

      outputDir: ' ',

    }],

  ],

};

```

## Configuration Options

The following configuration options are supported and are all optional.

By default none of the config options are set.

### outputDir

Define a directory where your markdown file should get stored.

Type: `String`


Required

## Merge all \*.md files

To generate only one markdown file use the **concat-cli** CLI to concat the files

```bash

concat-cli -f ./markdown-reporter/*.md -o mergeResult.md

```