Bridgetown Website README
Welcome to your new Bridgetown website! You can update this README file to provide additional context and setup information for yourself or other contributors.
Table of Contents
Prerequisites
Install
cd bridgetown-site-folder
bundle install && yarn install
Learn more: Bridgetown Getting Started Documentation.
Development
To start your site in development mode, run yarn start
and navigate to localhost:4000!
Use a theme, add some plugins, and/or run some automations to get started quickly.
Commands
# running locally
yarn start
# build & deploy to production
yarn deploy
# load the site up within a Ruby console (IRB)
bundle exec bridgetown console
Learn more: Bridgetown CLI Documentation
Deployment
You can deploy Bridgetown sites on "Jamstack" hosts (Netlify, Vercel, Render, etc.) or virtually any tranditional web server by simply building and copying the output folder to your HTML root.
Read the Bridgetown Deployment Documentation for more information.
To deploy run
$ yarn deploy BRIDGETOWN_ENV=production
$ mv docs/_bridgetown/static ./docs
$ find docs/ -name '*.html' -exec sed -ie 's/_bridgetown\///' {} \;
$ find docs/ -name '*.htmle' -exec rm {} \;
Contributing
If repo is on GitHub:
- Fork it
- Clone the fork using
git clone
to your local development machine. - 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