Skip to content

A simple TypeScript template for Alpine.js plugins

License

Notifications You must be signed in to change notification settings

rehhouari/alpine-typescript-plugin-template

 
 

Repository files navigation

Alpine Plugin Template

One short line about the plugin.

GitHub tag (latest by date) npm bundle size Downloads from Jsdelivr NPM npm Changelog

About

A short bit of information about the plugin and what it does.

Be sure to do a site wide search/replace for the following:

{author-name} - Example: Rafik El Hadi Houari
AlpinePlugin - The name of your plugin in PascalCase
{current-year} - Example: 2021
{package-description} - The summary
{npm-package} - The name of your npm package. Example: `plugin-name`
{repository} -  The full github repository path. Example: `username/plugin-name`

Installation

CDN

Include the following <script> tag in the <head> of your document:

<script src="https://cdn.jsdelivr.net/gh/{repository}@v0.0.0/dist/index.js"></script>

Important: This must be added before loading Alpine.js when using CDN links.

Versioning

This projects follow the Semantic Versioning guidelines.

License

Copyright (c) {current-year} {author-name} and contributors

Licensed under the MIT license, see LICENSE.md for details.

About

A simple TypeScript template for Alpine.js plugins

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 63.8%
  • JavaScript 36.2%