Website

This project is the document website of Farrow.

Contributing Guide

Thanks for that you are interested in contributing to Farrow Doc website.

Local Development

To develop locally:

1. Fork this repository to your own GitHub account and then clone it to your local.

2. Create a new branch:

   $ git checkout -b MY_BRANCH_NAME

3. Install yarn:

   $ npm install -g yarn

4. Install the dependencies with:

   $ yarn

5. Go into docs which you want to contribute.

   $ cd ./docs/*

6. Start developing.

   $ yarn start

Internationalization

Now we only just support en(default) and zh-cn. So if you want to do translation to zh-ch, you can

$ yarn run start -- --locale zh-cn

and edit the translation document in i18n/zh-cn.

Building

You can build website with

$ yarn build

Deploy

We used the deployment which the support to the Github Page. Run

$ GIT_USER=<Your GitHub username> yarn deploy

and then the build output of this project will be committed to branch release. And Page will deploy to https://farrowjs.com.