Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/michaelcurrin/bridgetown-quickstart

Starter template for a Bridgetown static site
https://github.com/michaelcurrin/bridgetown-quickstart

bridgetown ruby static-site

Last synced: 13 days ago
JSON representation

Starter template for a Bridgetown static site

Awesome Lists containing this project

README

        

# Bridgetown Quickstart
> Starter template for a Bridgetown static site

[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/bridgetown-quickstart?include_prereleases=&sort=semver)](https://github.com/MichaelCurrin/bridgetown-quickstart/releases/)
[![License](https://img.shields.io/badge/License-MIT-blue)](#license)

[![Made with Ruby](https://img.shields.io/badge/Ruby->=2.6-blue?logo=ruby&logoColor=white)](https://ruby-lang.org)
[![Made with Node.js](https://img.shields.io/badge/Node.js->=12-blue?logo=node.js&logoColor=white)](https://nodejs.org)
[![Made with Yarn](https://img.shields.io/badge/Yarn-1-blue?logo=yarn&logoColor=white)](https://classic.yarnpkg.com)
[![dependency - bridgetown](https://img.shields.io/badge/bridgetown-0.X-blue)](https://rubygems.org/gems/bridgetown)

## Preview


Sample screenshot

## Use this project

Add to your repos.

[![Use this template](https://img.shields.io/badge/Generate-Use_this_template-2ea44f?style=for-the-badge)](https://github.com/MichaelCurrin/bridgetown-quickstart/generate)

## What is Bridgetown?

- [bridgetownrb.com](https://www.bridgetownrb.com)
> Bridgetown is a Webpack-aware, Ruby-powered static site generator for the modern Jamstack era

See my [Bridgetown dev resources](https://michaelcurrin.github.io/dev-resources/resources/ruby/gems/bridgetown.html) to learn more.

See my [Bridgetown cookbook](https://michaelcurrin.github.io/code-cookbook/recipes/ruby/gems/bridgetown.html) for how to set up a new project from scratch, if you don't want to use this template project.

If you are interested in a established Ruby-based static generator, see my [jekyll-blog-demo](https://github.com/MichaelCurrin/jekyll-blog-demo/). Unlike Bridgetown, it doesn't require Node/Yarn and can be set up on GitHub Pages without a CI flow to deploy the site.

## Documentation
> Set up and run the site locally and deploy the site



[![View - Documentation](https://img.shields.io/badge/View-Documentation-blue?style=for-the-badge)](/docs/)

## Contributing

If repo is on GitHub:

1. Fork it
2. Clone the fork using `git clone` to your local development machine.
3. Create your feature branch (`git checkout -b my-new-feature`)
4. Commit your changes (`git commit -am 'Add some feature'`)
5. Push to the branch (`git push origin my-new-feature`)
6. Create a new Pull Request

## License

Released under [MIT](/LICENSE) by [@MichaelCurrin](https://github.com/MichaelCurrin)