Digital Grammars webpage

Repository for main company website at http://www.digitalgrammars.com/. Hosted by GitHub pages, which uses Jekyll website generator.

Running in Docker

Run:

$ ./run-docker.sh

Then browse to http://localhost:5050.

Running locally

Requires bundler and Jekyll.

If you don't have bundler:

gem install bundler

Install local dependencies:

bundle install --path vendor/bundle

To generate and serve locally:

bundle exec jekyll serve

Then browse to http://127.0.0.1:4000.

Building

Despite using Jekyll, some parts of the website need to built separately.

TypeScript and Babel are installed via Node and listed in the package dev-dependencies. To install node on your system:

brew install node

And then to install this package's dependencies locally:

npm install

scripts

All JavaScript files loaded by the webpage are in scripts/. Some of these are generated:

• Pitch.js is generated by GF: make script/Pitch.js
• editor.min.js is generated in two steps:
  1. compile src/editor.ts into scripts/editor.js using TypeScript
  2. minify scripts/editor.js into scripts/editor.min.js using Babel (Note that scripts/editor.js and scripts/editor.min.js.map are git-ignored, so will not end up in production)

styles

The stylesheet is in styles/styles.scss, written in Sass, which is a superset of CSS. Jekyll takes care of producing the CSS file from this SCSS, such that it is loaded from the webpage as styles/styles.css.

grammars

After updating the GF grammar, you should run:

make scripts/Pitch.js

And then make sure to commit the updates to this file in the repository.