markdown-magic-pulpo-schema
Document configurations built with Pulpo
Last updated 4 years ago by camachgk .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install markdown-magic-pulpo-schema 
SYNC missed versions from official npm registry.

Schema plugin

Add install command to markdown files via markdown-magic

Install

npm i markdown-magic markdown-magic-install-command --save-dev

Adding the plugin

See example.js for usage.

const Pulpo = require('pulpo');
const path = require('path');
const markdownMagic = require('markdown-magic');

const config = {
  transforms: {
    SCHEMA: require('./index.js')(new Pulpo({
      host: {
        description: 'Host for the server',
        type: 'string',
        default: 'localhost',
        argv: 'host'
      },
      port: {
        description: 'Port for dev server to run on',
        type: 'number',
        default: '3000',
        env: 'PORT'
      }
    }))
  }
}

const markdownPath = path.join(__dirname, 'README.md');
markdownMagic(markdownPath, config);

Usage in markdown

  • host (string) - Host for the server
    • default - localhost
    • argv - host
  • port (number) - Port for dev server to run on
    • default - 3000
    • env - PORT

Current Tags

  • 1.0.0                                ...           latest (4 years ago)

1 Versions

  • 1.0.0                                ...           4 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 1
Dependencies (0)
None
Dev Dependencies (2)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |