Skip to content

MyWarp/mywarp.github.io

Repository files navigation

Website for the MyWarp project, hosted on GitHub pages.

Build Status Website Status License

About

We use Middleman to build the site. Javascript is bundled using esbuild, stylesheets using Dart SASS.

Middleman automatically calls both tools during the build process via its external pipeline. This allows us to manage frontend dependencies via NPM, import them in SASS and Javascript, and parse Javascript via Babel. After the build, Middlemann calls PurgeCSS to remove unused CSS.

Assets build by via the external pipeline can be found in the assets folder, assets build by Middleman in the source folder. For the configuration of the external tools, check the scripts section in package.json.

Build

Install Ruby, Node (including NPM) and ImageOptim. Then, run:

bundle install
npm install
bundle exec middleman build

For development you might want to use Middleman's build-in server: bundle exec middleman.

Deployment

The src branch contains the site's source. It is build automatically by a Github Action and deployed to GitHub Pages. (The master branch contains an old version of the final website that is no longer used.)

License

MyWarp binaries (in source/files/) are available under GPL3. Everything else is available under MIT.