andarist / babel.github.io

:globe_with_meridians: The Babel documentation website

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 [email protected]: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.

Linting markdown

npm test

This will lint markdown documents inside both the website and the imported repositories (like babel, babili, etc).

Testing compiled output

rake

Running this will check the compiled output for broken links and invalid markup.

Looking for support?

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