The website for Electron: electron.atom.io.
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.
Follow these steps to copy this repository to your computer and build the site:
git clone https://github.com/electron/electron.atom.io.git
cd electron.atom.io
npm run bootstrap
npm start
This site contains data gathered from various sources, and there's a build script for each:
npm run build-releases
fetches release data from the GitHub APInpm run build-docs
fetches version list from S3, fetches docs for the highest release version number, fixes their links, and adds YML frontmatter for Jekyll to use.npm run build-awesome
copies awesome-electron data into the_data
directorynpm run build-userland
copies electron-userland-reports data into the_data
directorynpm run build-apps
copies electron-apps data into the_data
directory
To run all of the build scripts serially:
npm run build
npm test
To verify all the links in the site:
cd electron.atom.io
npm start
Wait for the app to start, then in another shell:
cd electron.atom.io
npm run link-checker
Thanks for contributing to the site! Checkout the contributing documentation for guidelines on pull requests.