Bridgetown is a next-generation, progressive site generator & fullstack framework, powered by Ruby


Keywords
blog-engine, bridgetown, documentation-tool, esbuild, jamstack, ruby, static-site-generator
License
MIT
Install
gem install bridgetown -v 1.0.0.alpha3

Documentation

Bridgetown

Bridgetown is a next-generation, progressive site generator & fullstack framework, powered by Ruby. Bridgetown takes your local content and external data loaded from APIs; renders templates in Markdown, ERB, and many other formats; automatically compiles frontend assets via esbuild; and exports a complete website ready to be served by fast CDNs like Render or traditional web servers. Bridgetown also integrates closely with Roda for fullstack, dynamic web application functionality—but only when and where you need it.

Build Status Gem Version Licensed MIT Join the Discord Chat PRs welcome!


Special Thanks to Our GitHub Sponsors! 🙏 🎉

Say howdy 👋 to our blossoming list of current and past sponsors of Bridgetown on GitHub! You too can join this list and sponsor open source "alt" Ruby development.

svoop rahoulb joshuap skvk monfresh
@svoop @rahoulb @joshuap @skvk @monfresh
Website Website Website Website
renuo subsevenx collindonnell nbkkb7x bpo
@renuo @subsevenx @collindonnell @nbkkb7x @bpo
Website Website Website Website
DRBragg andrewmcodes karloscarweber swilgosz ttilberg
@DRBragg @andrewmcodes @karloscarweber @swilgosz @ttilberg
Website Website Website Website Website
Brem-LLC posiczko fuzzygroup maxveldink oleingemann
@Brem-LLC @posiczko @fuzzygroup @maxveldink @oleingemann
Website Website Website Website Website
onurozer joelhawksley coreyaus johlym pascallaliberte
@onurozer @joelhawksley @coreyaus @johlym @pascallaliberte
Website Website Website Website Website
luctus AbuMareBear rootnoob matoni109 jc00ke
@luctus @AbuMareBear @rootnoob @matoni109 @jc00ke
Website Website
jespr MikeRogers0 existentialmutt jr180180 eclectic-coding
@jespr @MikeRogers0 @existentialmutt @jr180180 @eclectic-coding
Website Website
williamkennedy adrianvalenz scoutapm-sponsorships asaaki leastbad
@williamkennedy @adrianvalenz @scoutapm-sponsorships @asaaki @leastbad
Website Website Website Website
jasoncharnes pascalwengerter wout johnchambers mtomov
@jasoncharnes @pascalwengerter @wout @johnchambers @mtomov
Website Website Website
marcoroth miatrinity pilotcph
@marcoroth @miatrinity @pilotcph You Next?
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.

Star History

Star History Chart


Start Here

Get Up to Speed

  • Explore the Folder Structure of a Bridgetown website
  • Start adding content to your site in the form of Resources
  • Learn how Front Matter works for adding metadata to resources
  • Add extra information to your site with Data Files
  • Customize the Permalinks your resources are generated with
  • Use Template Engines like Liquid, ERB, and Serbea to author sophisticated template designs
  • Extend with Custom Plugins to generate and manipulate content specific to your site
  • Discover how to add Frontend Assets using esbuild 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 git@github.com:bridgetownrb/bridgetown.git
$ cd bridgetown
$ bundle # install development gems
$ bundle exec rake # run the full test suite

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

$ script/test test/test_foo.rb

Or run script/test to run the full test suite. You can also run script/cibuild to include Rubocop linting, etc., and at the root level of the repo, run bundle exec rake test_all to test the entire monorepo.

To switch one of your own 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"
# additional gems as needed

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
@jaredcwhite @jaredmoody @andrewmcodes @ParamagicDev @MikeRogers0
Portland, OR Portland, OR Wilmington, NC Providence, RI Ny-Ålesund, Svalbard
wout codemargaret julianrubisch ianbayne ayushn
@wout @codemargaret @julianrubisch @ianbayne @ayushn21
Brighton, UK Portland, OR Vienna, Austria Tokyo, Japan London, UK
pascalwengerter marketerly juanvqz katafrakt
@bkmgit @pascalwengerter @marketerly @juanvqz @katafrakt
Lisbon, Portugal Tripoli, Libya Oaxaca, México Wrocław, PL
erikyuzwa eclectic-coding collindonnell juhat
@erikyuzwa @eclectic-coding @collindonnell @juhat @debashis-biswal
Calgary, AB North Carolina, US Portland, OR Budapest, Hungary
nachoal deivid-rodriguez Eric-Guo jacobherrington
@nachoal @deivid-rodriguez @Eric-Guo @jacobherrington @fpsvogel
CDMX, México Madrid, Spain Shanghai, China Fayetteville, AR Lexington, KY
vvveebs rickychilcott tommasongr tombruijn svoop
@vvveebs @rickychilcott @tommasongr @tombruijn @svoop
London, UK Ohio, US Amsterdam, The Netherlands Milan, IT Europe
michaelherold joemasilotti ikass jw81 jw81
@michaelherold @joemasilotti @ikass @jw81 @MSILycanthropy
Omaha, NE Portland, OR Latvia Kansas City, MO Kansas City, MO
You Next?
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.