Socket
Book a DemoInstallSign in
Socket

@instructure/ui-docs

Package Overview
Dependencies
Maintainers
10
Versions
16
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@instructure/ui-docs

A webpack plugin to generate documentation made by Instructure Inc.

3.0.0
latest
Source
npmnpm
Version published
Maintainers
10
Created
Source

npm

Installation

npm install @instructure/ui-docs

Usage

In your webpack config add the plugin:

const path = require('path')
const pkg = require('./package.json')

new DocsPlugin({
  title: `${pkg.name} : ${pkg.description} (${pkg.version})`,
  favicon: path.join(__dirname, 'logo.png'),
  library: {
    packageName: pkg.name,
    packageMain: pkg.main,
    name: 'MyLibrary',
    description: pkg.description,
    version: pkg.version,
    repository: pkg.repository.url,
    author: pkg.author,
    codepen: { // codpen button form data
      js_external: [
        `${pkg.homepage}common.js`,
        `${pkg.homepage}${pkg.name}.js`,
        `${pkg.homepage}globals.js`
      ]
    }
  },
  globals: { // for component playground and codepen examples
    moment: 'moment'
  },
  files: {
    components: [
      path.join(__dirname, 'lib/components/*/index.js') // only top level components
    ],
    docs: [
      path.join(__dirname, 'README.md'),
      path.join(__dirname, 'CHANGELOG'),
      path.join(__dirname, 'docs/*.md')
    ]
  },
  template: path.join(__dirname, 'templates/docs/index.tmpl.html')
})

Browser Support

  • Internet Explorer 11 and Edge
  • Chrome, Safari, Firefox (last two versions)

License

MIT

FAQs

Package last updated on 03 Aug 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.