7b196f1cf0
add blog posts section to contributing doc |
||
|---|---|---|
| _data | ||
| _docs | ||
| _drafts | ||
| _includes | ||
| _layouts | ||
| _pages | ||
| _posts | ||
| _sass | ||
| bower_components | ||
| css | ||
| images | ||
| js | ||
| lib | ||
| script | ||
| spec | ||
| .gitignore | ||
| .node-version | ||
| .travis.yml | ||
| CNAME | ||
| CONTRIBUTING.md | ||
| Gemfile | ||
| Gemfile.lock | ||
| Gruntfile.js | ||
| LICENSE.md | ||
| README.md | ||
| _config.yml | ||
| package.json | ||
README.md
electron.atom.io
The website for Electron: electron.atom.io.
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.
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
CLI for Docs, Releases & Version Information
This site contains the latest version of Electron docs, recent release change logs and the current versions of Node.js, Chromium and V8 that are used in Electron.
Each of these are updated here when a new Electron is released. 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
Documentation
Versions of Electron documentation are fetched from the electron/electron repository's docs directory. The site contains the latest version of docs and links to older versions of the docs in the repository.
To fetch documentation for a specific version:
$ script/docs <version> [options]
# Example:
$ script/docs v0.26.0 --latest
Options:
--latest Set this version as the latest version of Electron in _config.yml and replace the existing documentation.
Release Notes
The most recent release notes from the electron/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 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.