Bridgetown

Bridgetown is a Webpack-aware, Ruby-powered static site generator for the modern Jamstack era. Bridgetown takes your content, API data, and frontend assets; renders templates in Markdown, Liquid, ERB, and many other formats; and exports a complete website ready to be served by fast Jamstack services like Vercel or Render or traditional web servers like Caddy or Nginx.

Special Thanks to Our Founding Members! 🙏 🎉

Say howdy 👋 to our growing list of the first twenty sponsors of Bridgetown on GitHub. You too can join this list and sponsor Bridgetown!

@cabgfx	@andrewmcodes	@miatrinity	@marcoroth_	@mtomov
Website	Website	Website	Website

@johnchambers	@wout	@pascalwengerter	@DRBragg	@jasoncharnes
	Website	Website	Website	Website

@leastbad	@asaaki	@scoutapm-sponsorships	@adrianvalenz	You Next?
	Website	Website		Website

Commercial Support

Bridgetown development is spearheaded by Portland-based web studio Whitefusion. Contact us if you need commercial support for your Bridgetown content strategy, site design, or deployment. Also providing commercial support: Radioactive Toy based in the UK.

Start Here

• Install the Bridgetown gem
• Familiarize yourself with the Command Line Usage and Site Configuration
• Explore the best options for Deploying Your Site when it's ready to go live
• Have questions? Check out our new Bridgetown Discussions on GitHub or chat on Discord
• Fork Bridgetown and contribute your own improvements!

Get Up to Speed

• Explore the Folder Structure of a Bridgetown website
• Start adding Pages and Posts
• Learn how Front Matter works
• Put information on your site with Variables and Data Files
• Customize the Permalinks your posts are generated with
• Use the built-in Liquid Tags and Filters to author sophisticated content and template designs
• Extend with Custom Plugins to generate content specific to your site
• Discover how to add Frontend Assets using Webpack for a modern Javascript & CSS build pipeline

Testing Locally

If you'd like to hack away on Bridgetown directly, you'll need to clone this repo and ensure the test suite passes. Note that this is a "monorepo", meaning that multiple Rubygem codebases are stored within a single repo.

$ git clone [email protected]:bridgetownrb/bridgetown.git
$ cd bridgetown
$ bundle # install development gems
$ bundle exec rake # run the full test suite

After making changes in bridgetown-core, if you want to run a single unit test, you can use the command:

$ script/test test/test_foo.rb

If you are only updating a Cucumber .feature file, you can use the command:

$ script/cucumber features/foo.feature

Both script/test and script/cucumber can be run without arguments to run its entire respective suite.

To switch one of your website repos to using the local gem, add the local gem path to the site's Gemfile as follows:

gem "bridgetown-core", path: "/path/to/bridgetown/bridgetown-core"

Need help?

If you don't find the answer to your problem in our docs, ask the community for help.

Code of Conduct

In order to have a more open and welcoming community, Bridgetown adheres to a code of conduct adapted from the Contributor Covenant.

Please adhere to this code of conduct in any interactions you have in the Bridgetown community. It is strictly enforced on all official Bridgetown repositories, websites, and resources. If you encounter someone violating these terms, please let one of our core team members know and we will address it as soon as possible.

Contributors

Bridgetown is built by:

@jaredcwhite	@jaredmoody	@andrewmcodes	@ParamagicDev	@MikeRogers0
Portland, OR	Portland, OR	Wilmington, NC	Providence, RI	Ny-Ålesund, Svalbard

@wout	@codemargaret	@julianrubisch	@ianbayne	@ayushn21
Brighton, UK	Portland, OR	Vienna, Austria	Tokyo, Japan	London, UK

@bkmgit	@pascalwengerter	@marketerly	@juanvqz	You Next?
	Lisbon, Portugal	Tripoli, Libya	Oaxaca, México	Anywhere

Interested in joining the Bridgetown Core Team? Send a DM to Jared in Discord and let's chat!

License

The gem is available as open source under the terms of the MIT LICENSE file.