Skip to content

A distributable package of modules used in the Electric Book Template and derivations thereof.

Notifications You must be signed in to change notification settings

electricbookworks/electric-book-modules

Repository files navigation

Electric Book Modules

A distributable package of modules used in the Electric Book Template and derivations thereof.

Publishing changes

Commit all changes and push to origin.

To automatically publish the package changes as an incremental patch, run:

npm run release

This will bump the current patch version (the third value) by one.

To update to a new minor or major verion, first change the version in the package.json file, and then run:

npm run first-release

To get this release inside an Electric Book Template, update the version number in the relevant template's package.json file and install it: npm install.

Using yalc for local development

To view changes to this package locally from the template importing it without having to create a new release each time, use yalc.

Install yalc:

npm i yalc -g

Publish this package to your local machine store, by running this in the root of this repo:

yalc publish

Then, inside the template repo that is consuming this package, run:

yalc link @electricbookworks/electric-book-modules

To push changes the book server template consuming it, run this inside this repo:

yalc push

To watch for changes and have them automatically pushed with yalc:

npm run watch

This will have no effect on deployments external to your local machine. To publish all your changes as a new release, follow the instructions under 'Publishing changes' above.

About

A distributable package of modules used in the Electric Book Template and derivations thereof.

Resources

Stars

Watchers

Forks

Packages

No packages published