keycloak_theme/README.template.md
2021-02-20 11:51:44 +01:00

1.5 KiB

#{DESC}#

Home - Documentation

Install / Import

$ npm install --save #{REPO_NAME}#
import { myFunction, myObject } from "#{REPO_NAME}#";

Specific imports:

import { myFunction } from "#{REPO_NAME}#/myFunction";
import { myObject } from "#{REPO_NAME}#/myObject";

Import from HTML, with CDN

Import it via a bundle that creates a global ( wider browser support ):

<script src="//unpkg.com/#{REPO_NAME}#/bundle.min.js"></script>
<script>
    const { myFunction, myObject } = #{REPO_NAME_NO_DASHES}#;
</script>

Or import it as an ES module:

<script type="module">
    import {
        myFunction,
        myObject,
    } from "//unpkg.com/#{REPO_NAME}#/zz_esm/index.js";
</script>

You can specify the version you wish to import: unpkg.com

Contribute

npm install
npm run build
npm test