styleguidist-scrapper

KO | EN

gitlite — search

#hacktoberfest #go #android #rust #linux #docker #macos #windows #cli #kubernetes #awesome-list #ios #openai #open-source

styleguidist-scrapper

(★ 27)

Scrapper script for documentation generated by https://react-styleguidist.js.org/

styleguidist-scrapper Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# styleguidist-scrapper

This is a scrapper script targeting documentation generated by [react-styleguidist](https://react-styleguidist.js.org/).

It's main purpose is to generate metadata of documented examples which can be used to generate visual snapshot tests using [jest](https://facebook.github.io/jest/), [jest-image-snapshot](https://github.com/americanexpress/jest-image-snapshot) and [puppeteer](https://github.com/GoogleChrome/puppeteer).

## API

```js
scrape(styleguideUrl: string): Promise<Array<ExampleMetadata>>
```

## Types

**ExampleMetadata**
```js
type ExampleMetadata = {
  // component name
  component: string,
  // directory where it is located
  dir: string,
  // URL with isolated example
  url: string,
  // title for the example
  // assumed to be paragraph above the example
  title: string,
  // CSS selector for the example
  // useful for targeting screenshots
  selector: string,
}
```

## Usage

```js
const fs = require('fs')
const scrape = require('styleguidist-scrapper')

scrape('http://localhost:6060').then(examples => {
  fs.writeFile('./examples-metadata.json', JSON.stringify(examples), 'utf8')
})
```

styleguidist-scrapper

styleguidist-scrapper Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

styleguidist-scrapper

styleguidist-scrapper Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README