История

Xuan Huang 5dfa119d3d Replace `master` with `main` or `HEAD` Summary: This diff looks for references to `master` and replace them with `main` or `HEAD` to prepare for the upcoming default branch change. Reviewed By: yungsters Differential Revision: D29670904 fbshipit-source-id: 3279d0eb3de09edb494b52a922feb3915cc3b1a9		2021-07-16 18:55:55 -07:00
..
plugins	Playground refactoring	2020-05-21 13:11:38 -07:00
src	Full Screen Mode enabled for the Explain Like I’m 5: Hermes video (#538 )	2021-06-22 10:28:25 -07:00
static	chore: expose docs files on the website (#430 )	2020-12-11 23:36:13 -08:00
.gitignore	Initial commit	2019-07-10 09:43:55 -07:00
README.md	Replace `master` with `main` or `HEAD`	2021-07-16 18:55:55 -07:00
build-hermes.sh	build playground Hermes as WASM and refactor hermes worker	2021-05-11 16:10:15 -07:00
docusaurus.config.js	Replace `master` with `main` or `HEAD`	2021-07-16 18:55:55 -07:00
package.json	chore: Docusaurus with webpack 5 (#500 )	2021-05-04 22:41:27 -07:00
postprocess.js	Add missing copyright headers to a few files	2019-07-12 12:53:08 -07:00
sidebars.json	Improve the website in prep for 0.8 release	2021-05-11 16:10:16 -07:00
yarn.lock	Bump ua-parser-js from 0.7.22 to 0.7.28 in /website (#508 )	2021-06-09 14:58:33 -07:00

README.md

Hermes JS Engine Website

This directory contains the source code for the Hermes JS Engine website available at https://hermesengine.dev/.

Developing

This project uses Docusaurus v2.

To develop locally run yarn to install dependencies and then yarn start to start the website and begin development. Docusaurus will watch the files and automatically compile changes and update the browser preview.

To develop the playground, see the playground Hermes section below.

For more information see the Docusaurus website.

Deploying

To deploy you must have push access.

We deploy the website to the gh-pages branch of this repo. At a high level, the process of deploying is to build the website assets using Docusaurus, copy the built files over to the gh-pages branch (replacing everything that's there except hermes.js and hermes.mem), verify the changes, and push to the gh-pages branch.

The full steps are:

git checkout main
cd website
Restore or update the playground Hermes
Run yarn build to build the site
Run npm run serve to preview the site
Verify the site is correct
Verify all file changes are correct
Run USE_SSH=true GIT_USER=<GITHUB_USERNAME> yarn deploy to deploy

GitHub will automatically update the site within minutes.

The Playground Hermes

The playground uses a Hermes WASM module built with emscripten. The built artifacts (hermes.js and hermes.wasm) are intentionally not checked-in, but are required to be present for developing the playground and deploying.

If you will not be compiling a new verison of Hermes for the playground with your deploy, simply download the hermes.js and hermes.wasm from the gh-pages branch and copy them under the static/.

If you would like to deploy a new version, you can run ./website/build-hermes with the required arguments (see building with emscripten for prerequisites) to compile from source. The script should automatically copy the built hermes.js and hermes.wasm to static/.