Installation

Minze can be installed in several different ways.

npm

Installing from npm:

# npm
$ npm install minze

# yarn
$ yarn add minze

# pnpm
$ pnpm add minze
import Minze, { MinzeElement } from 'minze'

class MyElement extends MinzeElement {
  html = () => `Hello Minze!`
}

Minze.defineAll([MyElement])
<my-element></my-element>

CLI

Installing via command line:

TIP

The CLI method scaffolds a Minze Dev and Publishing environment including rollup and vite.

Minze requires Node.js version >= 16.0.0

npm

# npm
$ npm init [email protected]

# yarn
$ yarn create minze

# pnpm
$ pnpm create minze

Then follow the prompts!

Templates

There are currently the following templates available:

  • JavaScript - js
  • TypeScript - ts

The shorthand can be used in command line options, e.g. --template ts

Command line options

You can directly specify the project name and template via additional command line options. For example, to scaffold a TypeScript environment, run:

# npm
$ npm init [email protected] my-project -- --template ts

# yarn
$ yarn create minze my-project --template ts

# pnpm
$ pnpm create minze my-project -- --template ts

CDN

Loading Minze via a CDN link from unpkg or jsdelivr. Pick one of the following:

unpkg

jsdelivr

Example

<html>
  <head></head>
  <body>
    <!-- custom component -->
    <my-element></my-element>

    <!-- minze -->
    <script src="//unpkg.com/[email protected]" defer></script>

    <!-- custom component definition -->
    <script type="module">
      class MyElement extends MinzeElement {
        html = () => `Hello Minze!`
      }

      Minze.defineAll([MyElement])
    </script>
  </body>
</html>