Skip to content
This repository was archived by the owner on Sep 27, 2022. It is now read-only.

foxford/foxford-docs-utils

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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