Discover Meteor Static

This is a Middleman static site generator wrapper for the Discover Meteor book's Markdown sources.

It takes the Markdown sources in any language and generates a static HTML site from them.

Instructions

Clone this repo:

git clone git@github.com:DiscoverMeteor/DiscoverMeteorStatic.git

Then install Middleman and the other required gems:

bundle install

Initialize Git submodules:

git submodule init

Update them:

git submodule foreach git pull origin master

Then run with:

middleman

Managing Languages

This repo uses one git submodule per language. Please take care not to commit any translations sources as part of this repo itself.

Switching Language

Middleman can only generate files for a single language at a time. It will look for a DMLANG environment variable, but if it can't find it it will fall back to a default language, as specificed in line 11 of config.rb:

LANG = ENV['DMLANG'] || DEFAULTLANG

We recommend using that environment variable if you can. Otherwise, the easiest way to change your local language is simply to change this hardcoded string, and then restart Middleman.

Troubleshooting

In some cases, the README.md file included with each language's repo can trigger a Middleman error, because it lacks the proper formatting. Simply delete it to get rid of the error (but don't commit the deletion!).

Deploying

Pushing a commit to this repo will automatically redeploy all translation instances (see full list).

Here's the full process, step by step:

Update a language's translation.
Commit your changes and push them to the GitHub repo (for example, DiscoverMeteor_Es).
Go to your local copy of the DiscoverMeteorStatic repo.
Update all submodules (including your language's translation) with git submodule foreach git pull origin master.
Commit your changes to the submodules (with git add -A and git commit -m 'updated languages' as usual).
Push your changes to the DiscoverMeteorStatic repo.

idoivri / DiscoverMeteorStatic