32 lines
2.0 KiB
Markdown
32 lines
2.0 KiB
Markdown
# @push.rocks/metadoc
|
|
a metadoc module for progressivly enhancing documents
|
|
|
|
## Availabililty and Links
|
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/metadoc)
|
|
* [gitlab.com (source)](https://code.foss.global/push.rocks/metadoc)
|
|
* [github.com (source mirror)](https://github.com/push.rocks/metadoc)
|
|
* [docs (typedoc)](https://push.rocks.gitlab.io/metadoc/)
|
|
|
|
## Status for master
|
|
|
|
Status Category | Status Badge
|
|
-- | --
|
|
GitLab Pipelines | [![pipeline status](https://code.foss.global/push.rocks/metadoc/badges/master/pipeline.svg)](https://lossless.cloud)
|
|
GitLab Pipline Test Coverage | [![coverage report](https://code.foss.global/push.rocks/metadoc/badges/master/coverage.svg)](https://lossless.cloud)
|
|
npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/metadoc)](https://lossless.cloud)
|
|
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/push.rocks/metadoc)](https://lossless.cloud)
|
|
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
|
|
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
|
|
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@push.rocks/metadoc)](https://lossless.cloud)
|
|
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/metadoc)](https://lossless.cloud)
|
|
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/metadoc)](https://lossless.cloud)
|
|
|
|
## Usage
|
|
Use TypeScript for best in class intellisense
|
|
For further information read the linked docs at the top of this readme.
|
|
|
|
## Legal
|
|
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|