@mitsuru793/document-generator-package-bundle
Document generator for package bundle
Last updated a year ago by mitsuru793 .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @mitsuru793/document-generator-package-bundle 
SYNC missed versions from official npm registry.

Document Generator Package Bundle

This generates document for my bundle of npm packages. I don't have to write a README.md for the bundle.

Installation

$ yarn add -D @mitsuru793/document-generator-package-bundle

Write template

Command

document-generator-package-bundle render:readme 'purpose for bundle'

Script File

import {Template} from '@mitsuru793/document-generator-package-bundle'

async function main(): Promise<void> {
  // Pass a purpose of bundle as 1st argument.
  // "to play music" is injected to readme.
  
  // Fetch npm package of dependencies internal.
  // So you have to use await.
  const text = await Template.readme('to play music')
  console.log(text)
}

main()

Current Tags

  • 1.1.3                                ...           latest (a year ago)

5 Versions

  • 1.1.3                                ...           a year ago
  • 1.1.2                                ...           a year ago
  • 1.1.1                                ...           a year ago
  • 1.1.0                                ...           a year ago
  • 1.0.0                                ...           a year ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (5)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |