Bridgetown is a next-generation, progressive site generator & fullstack framework, powered by Ruby. 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 CDNs like Render or traditional web servers like Caddy or Nginx.
![PRs welcome!](https://camo.githubusercontent.com/11951903d3f6c4432a5b891d70f22b7065d9d4fefcc19e9af42542a04cb6217e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5052732d77656c636f6d652d626c75652e737667)
Special Thanks to Our GitHub Sponsors! 🙏 🎉
Say howdy 👋 to our growing list of past & present sponsors of Bridgetown on GitHub!
You too can join this list and sponsor Bridgetown.
![](https://camo.githubusercontent.com/685518bda375b34b7b7a5e13b9a2ec9fcf796a3cec4f6842ba6f4d60a1bb95e2/68747470733a2f2f7777772e67726176617461722e636f6d2f6176617461722f30303030303030303030303030303030303030303030303030303030303030303f643d6964656e7469636f6e26733d31323826) |
You Next? |
|
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 Chart](https://camo.githubusercontent.com/3231322098d966bdd1740eebf7a96eb5c8c17a86af12867a98c32b63ea151855/68747470733a2f2f6170692e737461722d686973746f72792e636f6d2f7376673f7265706f733d627269646765746f776e72622f627269646765746f776e26747970653d44617465)
- 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 or Webpack for a modern Javascript & CSS build pipeline
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 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"
If you don't find the answer to your problem in our docs, ask the community for help.
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.
Bridgetown is built by:
Interested in joining the Bridgetown Core Team? Send a DM to Jared in Discord and let's chat!
The gem is available as open source under the terms of the MIT LICENSE file.