| Command | Description | |-----------------------------:|:---------------------------| | npm test | Run eslint check |

Getting started

1. npm i

Usage

Inject styleguideConfigMixin into your styleguidist.config.js to get all the documentation components and styles.

const { styleguideConfigMixin } = require('@foxford/foxford-docs-utils')

module.exports = {
  ...styleguideConfigMixin,
  /* If you want to have favicon, logo and images */
  assetsDir: resolve(__dirname, 'node_modules/@foxford/docs-utils/assets'),
  /** Your config here */
}

Important documents

• React-styleguidist
• Markdown cheatsheet