"Fossies" - the Fresh Open Source Software Archive

Member "flow-0.149.0/website/README.md" (14 Apr 2021, 1411 Bytes) of package /linux/www/flow-0.149.0.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format). Alternatively you can here view or download the uninterpreted source code file. A member file download can also be achieved by clicking within a package contents listing on the according byte size field.

Flow Documentation & Website

We use Jekyll to build the site.

Installation

If you are working on the site, you will want to install and run a local copy of it.

Start by cloning the website recursively to pull in all submodules:

git clone git@github.com:facebook/flow.git

Dependencies

In order to use Jekyll, you will need to have Ruby installed. macOS comes pre-installed with Ruby, but you may need to update RubyGems (via gem update --system). Otherwise, RVM and rbenv are popular ways to install Ruby.

The version of the Pygment syntax highlighter used by Jekyll requires Python 2.7.x (not 3.x). macOS comes pre-installed with Python 2.7, but you may need to install it on other OSs.

Once you have RubyGems and installed Bundler (via gem install bundler), use it to install the dependencies:

$ cd website
$ bundle install

Instructions

First, make sure to follow the instructions on building Flow in the root directory of this repository.

Use Jekyll to serve the website locally (by default, at http://localhost:8080):

$ cd website
$ make
$ open http://127.0.0.1:8080/