Installing bushido

Prerequisites

Coming soon: Installing with generator-sin

Installing with elioSin's own generator-sin is the recommended way.

yo sin:<bushido_theme>
gulp

This builds an elioSin package in your folder with the selected theme's scss files which you can use as is, or customize and build on.

Installing with NPM or Yarn as a dependency of your current project

Add god, eve, adon and bushido as NPM packages.

npm install @elioway/god @elioway/eve @elioway/adon @elioway/bushido --save-dev
yarn add @elioway/god @elioway/eve @elioway/adon @elioway/bushido --dev

Improve on it, then compile

@import "./node_modules/@elioway/god/stylesheets/settings";
@import "./node_modules/@elioway/bushido/<bushido_theme>/stylesheets/settings";
@import "./node_modules/@elioway/bushido/<bushido_theme>/stylesheets/theme";

Using your own settings

@import "my_bushido_settings";
@import "./node_modules/@elioway/god/stylesheets/theme";
@import "./node_modules/@elioway/bushido/<bushido_theme>/stylesheets/theme";

Add it to your compile funnel

<link
    rel="stylesheet"
    href="node_modules/@elioway/bushido/<bushido_theme>/dist/css/<bushido_theme>.min.css"
/>

Add any of the theme's scripts to the bottom of the page:

  <script
    src="https://code.jquery.com/jquery-3.4.1.slim.min.js"
    integrity="sha256-pasqAKBDmFT4eHoN2ndd6lN370kFiGUFyTiUHWhU7k8="
    crossorigin="anonymous"
  ></script>
  <script src="node_modules/@elioway/bushido/<bushido_theme>/dist/js/adons.js"></script>
  <script src="node_modules/@elioway/bushido/<bushido_theme>/dist/js/main.js"></script>
</body>

Development

GIT is also a fine way to install bushido.

git clone https://gitlab.com/elioway/elioway.gitlab.io.git elioway
cd elioway
git clone https://gitlab.com/elioway/eliosin.git
cd eliosin
git clone https://gitlab.com/eliosin/bushido.git
cd bushido/<bushido_theme>
npm i|yarn
gulp

gulp watch issues

If gulp crashes while running "watch", try this shell command in Linux.

shell echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf sudo sysctl -p