https://github.com/halo-lab/eleventy-packages
Monorepo for all Eleventy plugins.
https://github.com/halo-lab/eleventy-packages
eleventy monorepo plugin
Last synced: 14 days ago
JSON representation
Monorepo for all Eleventy plugins.
- Host: GitHub
- URL: https://github.com/halo-lab/eleventy-packages
- Owner: Halo-Lab
- Created: 2021-09-10T14:54:47.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-04-03T10:35:55.000Z (21 days ago)
- Last Synced: 2025-04-09T22:06:47.995Z (14 days ago)
- Topics: eleventy, monorepo, plugin
- Language: TypeScript
- Homepage:
- Size: 1.04 MB
- Stars: 24
- Watchers: 2
- Forks: 2
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Eleventy packages
This monorepository groups several plugins and `kickin` CLI in order to make their development easier. Documentation for every package is in their own folders. Please, refer to them if you search for plugin's behavior.
It consists of:
1. [eleventy-plugin-compress](./packages/eleventy-plugin-compress)
2. [eleventy-plugin-pwa-icons](./packages/eleventy-plugin-pwa-icons)
3. [eleventy-plugin-scripts](./packages/eleventy-plugin-scripts)
4. [eleventy-plugin-styles](./packages/eleventy-plugin-styles)
5. [eleventy-plugin-workbox](./packages/eleventy-plugin-workbox)
6. [eleventy-plugin-cloudflare-image-resizing](./packages/eleventy-plugin-cloudflare-image-resizing)
7. [eleventy-shortcode-image](./packages/eleventy-shortcode-image)
8. [kickin](./packages/kickin)
## Prerequisites
This project relies on [npm workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces) feature that is available since npm `v7`. For Node version there aren't any restrictions.
1. `node` - at least last LTS release (preferable).
2. `npm` - `^7.0.0` (needed for workspaces).
## Development
### Building
For building packages use command below:
```
npm run build
```
### Publishing
For publishing a package use `release:*` commands.
> Don't forget to bump a version of the package.
### Commits
> Before committing changes be sure that they are described in `CHANGELOG.md` and `README.md` files under package that have been changed!
This project uses [Conventional Changelog Specification](https://github.com/conventional-changelog/) for structuring commit messages.
Commit message should have this structure:
```
type(scope?): subject
body?
footer?
```
> `?` means that section is optional.
- `type` can only be one of this words:
```
| `build` - changes that affect the build system or external dependencies.
| `chore` - unimportant small changes.
| `ci` - changes to our CI configuration files and scripts.
| `docs` - documentation only changes.
| `feat` - a new feature.
| `fix` - a bug fix.
| `perf` - a code change that improves performance.
| `refactor` - a code change that neither fixes a bug nor adds a feature.
| `revert` - a code change that returns back some functionality.
| `style` - changes that do not affect the meaning of the code.
| `test` - adding missing tests or correcting existing tests.
```
- `scope` is a name of the package that was changed.
- `subject` is a short description of the commit.
- `body` is a detailed description (reasons of the changes, what is done, how and so on.)
- `footer` can be used for marking issue ids on GitHub.
> You can refer to [Angular guidelines](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines) for extended information.
## Word from author
Have fun! ✌️
