🌐 The Babel documentation website
CSS JavaScript HTML Ruby Makefile
Latest commit 03885aa Jan 16, 2017 @existentialism existentialism committed with xtuc Bump submodules to update docs (#1140)
Permalink
Failed to load latest commit information.
_data New User: Tanda (#1139) Jan 16, 2017
_includes Bump submodules to update docs (#1140) Jan 16, 2017
_layouts Include babel-preset-env documentation (#1084) Dec 15, 2016
_posts Fix yarn link in 2016-12-07-the-state-of-babel.md (#1130) Jan 11, 2017
_sass Refactor home page header (#1125) Jan 11, 2017
blog Change pagination settings to point to blog (#1092) Dec 17, 2016
css Switch to jekyll Jan 6, 2015
docs Clarify how to disable babelrc lookup behavior (#1134) Jan 16, 2017
fonts add Docsearch (#977) Nov 15, 2016
images New User: Tanda (#1139) Jan 16, 2017
scripts fix(copy): find element in parent Jan 7, 2017
.editorconfig Update `editorconfig` to match reality Jun 21, 2015
.gitignore Add to clipboard button for cli commands/code (#998) Nov 23, 2016
.gitmodules Add Babylon documentation (#1107) Dec 31, 2016
404.html replace all http URLs with https equivalents (#813) May 2, 2016
CNAME rename 6to5 to babel Feb 15, 2015
Gemfile Switch to using the GitHub Pages gem (#1065) Dec 8, 2016
Gemfile.lock Switch to using the GitHub Pages gem (#1065) Dec 8, 2016
Makefile Use Babel package doc (#990) Nov 22, 2016
README.md Update contributing to the website (#1072) Dec 12, 2016
_config.yml feat: try in REPL Dec 24, 2016
apple-touch-icon.png optimize images Dec 16, 2015
browserconfig.xml Robust cross-device favicon support Jan 21, 2015
favicon-160x160.png optimize images Dec 16, 2015
favicon-16x16.png optimize images Dec 16, 2015
favicon-192x192.png optimize images Dec 16, 2015
favicon-32x32.png optimize images Dec 16, 2015
favicon-96x96.png optimize images Dec 16, 2015
favicon.ico Robust cross-device favicon support Jan 21, 2015
feed.xml Switch to jekyll Jan 6, 2015
index.md Refactor home page header (#1125) Jan 11, 2017
learn-es2015.md Reorganize the docs. (#1041) Dec 6, 2016
mstile-144x144.png optimize images Dec 16, 2015
mstile-150x150.png optimize images Dec 16, 2015
mstile-310x150.png optimize images Dec 16, 2015
mstile-310x310.png optimize images Dec 16, 2015
mstile-70x70.png optimize images Dec 16, 2015
package.json Add flex mixins directly instead Jan 10, 2017
repl.html Make REPL editors resizable by width. (#1003) Nov 29, 2016
users.html add extra comment (#1063) Dec 8, 2016

README.md

babel.github.io

This is the source for the babeljs.io website, powered by Jekyll.

This repo also contains babel's source documentation.

The babel repo is babel/babel

Feel free to suggest changes to our docs, or add new content!

Setup

$ git clone git@github.com:babel/babel.github.io.git
$ cd babel.github.io
  • Please install ruby, if not already installed.
    • Use which ruby or ruby --version, to verify if ruby is installed.
    • Make sure bundler is installed by running gem install bundler
  • Install jekyll dependencies by running bundle install
  • npm i to install this package's dependencies
  • To start the web server on your machine, check out this repo and run npm start.

Contributing to the website

To keep documentation in sync across all of Babel's packages and plugins, the majority of the website is sourced directly from the README files located inside their respective repositories (Babel's packages, Babili's packages, ...).

If you want to create a new page, you need to consider the following.

The package configuration in the header needs to correspond to your package name and package_source to its source repository. See packages.yml for the current supported sources.

Default value for package_source is babel.

layout: docs
title: babel-register (require hook)
description: How to use babel-register, the require hook.
permalink: /docs/usage/babel-register/
redirect_from:
 - /docs/usage/require/
package: babel-register
package_source: babel

Publishing README

{% include package_readme.html %}

For example babel.github.io/docs/plugins/preset-stage-0.md which then points to babel/packages/babel-preset-stage-0/README.md

If you encounter an Liquid Exception: Included file '_includes/.../packages/.../README.md' not found, please double check your package and package_source configuration.

Manually updating submodules

git submodule foreach git pull origin master

You can safely push them once updated. Note, the website will fetch all latest submodule versions during deployment.

Looking for support?

For questions and support please join our Slack community, channel #website or directly here.