This package has been deprecated

    Author message:

    This package has been replaced with @instructure/ui-docs-plugin and @instructure/ui-docs-client

    @instructure/ui-docs

    3.0.0 • Public • Published

    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

    Keywords

    none

    Install

    npm i @instructure/ui-docs

    DownloadsWeekly Downloads

    3

    Version

    3.0.0

    License

    MIT

    Last publish

    Collaborators

    • kyler-instructure
    • jonscheiding
    • instuici
    • codequistador
    • natearmstrong
    • eschiebel
    • maths22
    • hyan
    • jcrystal
    • skacsmark
    • itadmins
    • quizzesuici
    • instructure-toolsmiths-service-user
    • prenner
    • aogata-inst
    • acallejas
    • viktor.ohad
    • eszter.szabo
    • amireh-inst
    • daniel.hatas.instructure
    • brianlwatson
    • instout