Skip to content

Latest commit

 

History

History
42 lines (30 loc) · 1.67 KB

README.md

File metadata and controls

42 lines (30 loc) · 1.67 KB
Raw

Irmin website    OCaml-CI status Travis status

This repository contains the source code for irmin.org, which describes the Irmin distributed database and contains tutorials for getting started with Irmin.

Contributing

All contributions are welcome! The tutorial files can be found in data/tutorial.

Building the website locally

The website is generated using GatsbyJS. The following commands run an instance of the website locally:

git clone https://github.com/mirage/irmin.org
cd irmin.org

yarn install    # Install build dependencies
yarn run build  # Build the website
yarn run serve  # Serve the build at `localhost:9000`

When working on the website, an incremental development server can be run with yarn run develop, but beware that this may show stale artefacts.

Running tests/linting

  • The source code is formatted with Prettier, and this is enforced in the CI.
  • Any incorrectly formatted code will be reported by yarn run lint.
  • Use yarn run format to apply the changes.