/!\ This repo is now archived, please see nowjveillet/demainilpleut.dev
Static HTML version of demainilpleut.dev using the static website generator Jekyll.
This project uses Node.js, Gulp, PostCSS as dependencies to build an minify the CSS and JS.
On the ruby side, this project uses Bundler.
$ git clone [email protected]:jveillet/jk-demainilpleut.git
$ cd jk-demainilpleut/
# Build the docker container and install Gems dependencies and NPM dependencies
$ docker-compose build
# Run the tasks to build the CSS and JS
$ docker-compose run --rm web gulp build
# Lint the CSS and JS (required before commiting any CSS and/or JS updates).
$ docker-compose run --rm web gulp lint
# Launch the Jekyll build and start the server
$ docker-compose up
# (or)
$ docker-compose run --rm web bundle exec jekyll serve -H 0.0.0.0 --incremental
# The server will run on port 8080 (see docker-compose.yml)
# Add the latest node version to the sources
$ curl -sL https://deb.nodesource.com/setup_14.x | bash - \
# Install Node and Gulp
$ apt-get install -y nodejs
$ npm install -g gulp-cli
# Install the JS dependencies
$ npm install
# Run the tasks to build the CSS and JS
$ gulp build
# Lint the CSS and JS (required before commiting any CSS and/or JS updates).
$ gulp lint
$ brew install node
# Install Gulp
$ npm install -g gulp-cli
# Install the JS dependencies
$ npm install
# Run the tasks to build the CSS and JS
$ gulp build
# Lint the CSS and JS (required before commiting any CSS and/or JS updates).
$ gulp lint
$ git clone [email protected]:jveillet/jk-demainilpleut.git
$ cd jk-demainilpleut/
# Install the gem and dependecies the blog needs
$ bundle install
# Launch the Jekyll build and start the server
$ bundle exec jekyll serve --incremental
# The server will run on port 4000
# Building CSS (assets will be compiled and installed in assets/css/)
$ gulp build:css
# Building Javascript (assets will be compiled and installed in assets/js/)
$ gulp build:js
# Global build (CSS + JS, compiled and installed into their relative folders in assets/)
$ gulp build
# Linting CSS (lint every individual component from the _assets/css/ folder)
$ gulp lint:css
# Linting JS (lint every individual scripts from the _assets/js/ folder)
$ gulp lint:js
# Global codebase linting (CSS + JS)
$ gulp lint
# Delete bundled CSS and JS files
$ gulp clean
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
This project only accepts Pull Requests that references an issue.
- Fork it http://github.com/jveillet/jk-demainilpleut/fork
- Create your feature branch (git checkout -b my-new-feature)
- Run the specs and our linter (bin/cibuild)
- Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create new Pull Request
- Fork it http://github.com/jveillet/jk-demainilpleut/fork
- Create your feature branch for the new page (git checkout -b page/my-post-title)
- Create a post with the help of the command line:
bundle exec jekyll post "My post title"
, or a draft:bundle exec jekyll draft "My post title"
- When you are ready, publish the post or draft:
bundle exec jekyll publish _drafts/my-post-title.md
. You can specify a date by using the--date
argument. - Push to the branch (git push origin page/my-post-title)
- Create new Pull Request