包详细信息

@tagproject/docs-shared-config

tagproject723MIT3.0.4

Standard shared config for tagproject packages with Node.js and TypeScript

config, docs, shared, standard

自述文件

Package logo

Build Status npm Standard Shared Config

Standard Shared Config with docs for tagproject packages

Install

npm install @tagproject/docs-shared-config --save-dev

Usage

  • Add "prepare:docs": "docs-shared-config" to scripts property in your package.json
  • Rename your prepare scripts to prepare:[NAME]
  • Add "prepare": "run-s prepare:*"
  • Run npm run prepare

Configs

extract docs:

  • CODE_OF_CONDUCT.md
  • LICENSE
  • SECURITY.md

merge files:

  • .gitignore
  • .npmignore

append to package.json:

scripts:

  • prepare - run all prepare:*
  • prepare:docs - extract shared docs

dependencies:

更新日志


Contributors

@keindev