Willamette (Rubygems/NPM)

Your donations are gladly welcomed, and support the ongoing evolution and maintenance of the Willamette project.

If you're looking to contribute to the documentation website, that repo is here.

Usage

Willamette is currently in a "public beta" phase of development.

Documentation on how to install & customize Willamette is on the docs site here.

Requirements:

Ruby >= 3.3
Node >= 22
Bridgetown >= 2.2

Contributing

Willamette is part of the Bridgetown Center plugins program.

To test your changes to Willamette, you'll need to create a new Willamette-based test site first using the instructions linked to above. Verify the new test site works.

Then, you'll need to point your dependencies to a local folder of the gem. First, fork this repo and clone the fork using git clone to your local development machine. Then over in the test site, update your Gemfile:

gem "willamette", path: "../willamette"

and your package.json file (note you have to repeat all dependencies required by Willamette itself due to an npm limitation):

"dependencies": {
  "@awesome.me/webawesome": ">=3.6.0",
  "hotkeys-js": "^4.0.0",
  "pagefind": "^1.4.0",
  "willamette": "file:../willamette"
}

Then run bundle i && npm i. Your site should now be running on local Rubygem/NPM versions of Willamette.

From there, the process for this repo is typical:

Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create a new Pull Request

All contributions to Willamette are subject to the main Bridgetown Code of Conduct.