MinzePublishing
npm
If you set up an environment via the create-minze CLI, you can publish your components to npm in two simple steps.
1. Build
This command creates a dist directory with an
esbuild, aCDNbuild and Type Declarations (If you selected the TypeScript template).
bash
$ npm run build
bash
$ yarn build
bash
$ pnpm run build
2. Publish
bash
$ npm publish
TIP
This is a default npm command refer to the npm docs for more information.
Using
To use your package in a project simply install minze plus your package.
Let's assume you published your library under the name
my-awesome-package
npm
bash
$ npm install minze my-awesome-package
bash
$ yarn add minz emy-awesome-package
bash
$ pnpm add minze my-awesome-package
js
import Minze from 'minze'
import { MyAwesomeElement, MyAwesomeElementTwo } from 'my-awesome-package'
Minze.defineAll([MyAwesomeElement, MyAwesomeElementTwo])
html
<my-awesome-element></my-awesome-element>
<my-awesome-element-two></my-awesome-element-two>
CDN
If you have published your package to npm, you can also load it via a CDN link from unpkg or jsdelivr. Pick one of the following:
unpkg
//unpkg.com/[email protected]for latest version//unpkg.com/[email protected]pin to specific version
jsdelivr
//cdn.jsdelivr.net/npm/[email protected]for latest version//cdn.jsdelivr.net/npm/[email protected]pin to specific version
Example
html
<html>
<head></head>
<body>
<!-- custom components -->
<my-awesome-element></my-awesome-element>
<my-awesome-element-two></my-awesome-element-two>
<!-- cdn link -->
<script src="//unpkg.com/[email protected]" defer></script>
</body>
</html>