Joe's Own Editor website builder

This repository contains the code necessary to build a bootstrap based
website for Joe's Own Editor. It generates
html from templates, and uses markdown found in the JOE Mercurial repository
to generate information for releases, copies of the manual, and more. The
important dependent packages are:

• Bootstrap version 4 alpha 6 -
  Frontend framework
• bootswatch - Bootstrap themes
• marked - Markdown parser
• gulp - Build system
• ejs - Templating engine
• gulp-inject - Injects
  referenced assets into html.
• tocbot - For responsive tables
  of contents on manual, hacking, and install instructions pages.

Usage

Pre-setup

Install Node.js with
nvm. Then install gulp-cli globally.

    % nvm install v8.7.0
    % npm install -g gulp-cli

Regular maintenance

    # Install remote npm packages
    % npm install

    # Build
    % gulp

    # Build with dev-server (listens on port 3000, automatically
    # rebuilds and refreshes browsers when file changes are detected).
    % gulp dev

The full output goes to dist/ when built.

Note that gulp dev will not pick up changes to any of the JS files, nor
will it pick up new versions from versions.yml. However, templates, and
information from within a version specified in versions.yml will
result in changes to the output.

Release management

The versions.yml file specifies releases, download links, and hg commits.
When a new release is added, start by adding it there, and then rerunning
gulp as above.