electron.atom.io

The website for Electron (formerly known as Atom-Shell).

Build

This is a Jekyll site hosted on GitHub Pages. To build a Jekyll site you'll need a few things on your system so double check the Jekyll requirements. In addition to those, you'll need these Ruby gems:

$ gem install jekyll
$ gem install bundler

Follow these steps to copy this repository to your computer and build the site:

$ git clone https://github.com/atom/electron.atom.io.git
$ cd electron.atom.io
$ script/bootstrap
$ script/server

CLI for Docs, Releases & Version Information

This site has versioned documentation, recent release change logs and the current versions of Node.js, Chromium and V8 that are used in Electron.

Each of these are updated upon a minor release of Electron. They're done so with the command line interface detailed below.

You'll need Node.js installed on your system in order to use the CLI. Then you can install the dependencies:

$ cd electron.atom.io
$ npm install

Versioned Documentation

Versions of Electron documentation are fetched from the atom/electron repository's docs directory. To fetch documentation at a specific version:

$ script/docs <version> [options]
# Example:
$ script/docs v0.26.0 --latest

Options:

--latest Set this version as the latest version of documentation

Release Notes

The most recent release notes from the atom/electron repository are made available on the site and can be updated by running:

$ script/releases

Updating Node.js, Chromium and V8 Versions in use in Electron

To update the _config.yml in this site with the versions of Node.js, Chromium and V8 that the latest [minor release] of Electron is using run:

$ script/versions

Update all the Things at Once

The scripts above do each task separately but to run all the things at once:

$ npm run latest -- <version>
# Example:
$ npm run latest -- v0.36.0

Note This assumes version is the latest and sets it as such by default.

Testing

To test the documentation script:

$ npm test

Contributing

Thanks for contributing to the site! Checkout the contributing documentation for guidelines on pull requests.

License

MIT