Skip to content

Latest commit

 

History

History
106 lines (74 loc) · 3.27 KB

README.md

File metadata and controls

106 lines (74 loc) · 3.27 KB
Raw

demainilpleut.dev

Build Status Netlify Status

Static HTML version of demainilpleut.dev using the static website generator Bridgetown.

Table of Contents

Prerequisites

Install

Classic

cd demainilpleut.dev/
bundle install && yarn install

Docker

cd demainilpleut.dev/
docker compose build && docker compose up

Development

To start your site in development mode, run bin/bridgetown start and navigate to localhost:4000!

The same applies to the Docker installation, run docker compose up and the website is available at the same address.

Commands

# running locally
bin/bridgetown start

# build & deploy to production
bin/bridgetown deploy

# load the site up within a Ruby console (IRB)
bin/bridgetown console

Learn more: Bridgetown CLI Documentation

Tests

Basic tests are performed on the structure of the site (broken links, alt attributes on images,..), by using the html-proofer Ruby Gem.

They are launched automatically with every Pull Requests, via GitHub Actions (see cibuild.yml file).

You can run them manually via command line:

./bin/cibuild.sh

Or with Docker:

docker compose run --rm web bin/cibuild.sh

Contributing

To the code

This project only accepts Pull Requests that references an issue.

  1. Fork it http://github.com/jveillet/demainilpleut.dev/fork
  2. Clone the fork using git clone to your local development machine.
  3. Create your feature branch git checkout -b feature/issue-number.
  4. Run the specs and our linter bin/cibuild.
  5. Commit your changes git commit -am 'Add some feature'.
  6. Push to the branch git push origin feature/issue-number.
  7. Create new Pull Request.

To the articles

  1. Fork it http://github.com/jveillet/demainilpleut.dev/fork
  2. Clone the fork using git clone to your local development machine.
  3. Create your feature branch for the new page git checkout -b page/my-post-title
  4. Create a post in the src/_postsstarting with the date it should be published (ex: '2021-01-01_my-post-title').
  5. When you are ready, commit the page git commit -am 'My post title'.
  6. Push to the branch git push origin page/my-post-title.
  7. Create new Pull Request.