Skip to content

Latest commit

 

History

History
35 lines (28 loc) · 1.74 KB

README.md

File metadata and controls

35 lines (28 loc) · 1.74 KB

CSL Marketing website

Prerequisites

The following tools should be installed before starting:

  • NodeJS, npm, yarn
  • Ruby, Gem, Bundler
  • Jekyll
  • Sass

Set up instructions

  • yarn install
  • bundle install
  • yarn start to serve locally, with live reload, site will be available at http://localhost:8080/

Deployment

To deploy a new version of the app, just commit a new version on main. Netlify will compile the content and deploy automatically.

To simulate locally:

  • yarn run build

Configurations

  • The required configurations are all in _config.yml
  • Also edit package.json the name is used in the meta tags
  • Replace the different icon by yours in _images and in the root folder

Assets

  • SCSS partials should be located in _scss for better reading
  • Put all your images in _images the content of this folder will be moved to the _site/assets/images so you can access them with this path /assets/images/** in your templates, check the examples
  • Put all your Javascript files inside _src and import them from app.js or you can also add them as a new entry point in your webpack configuration file

Internationalization

  • All the posts should be there in inside _i18n folder inside its language, check the boilerplate examples
  • You can put your variables inside _i18n/en.yml (replace en with your language) and call them in your template with {% t variable_name.sub_variable %}
  • You can remove the plugin by removing gem 'jekyll-multiple-languages-plugin' from gemfile and jekyll-multiple-languages-plugin from plugins in _config.yml
  • We invite you to read the very good official documentation of the plugin Jekyll multiple language plugin