Skip to main content
Version: Next

Overview

logo

Formulaik is built from the ground up to be easy to use, convention driven and extensible so that it's easy to kickstart a project and maintain it. It's api makes it easy to fetch steps remotely and execute them with powerful side effects, transformers and validators.

Formulaik documentation​

This is the official documentation site for Formulaik. Content on this site is sourced in GitHub. For more information, see Contributing to Formulaik documentation.

This site is based on Docusaurus.

This site is deployed on Github Pages.

We use the Diátaxis documentation authoring framework which organizes technical documentation into a system based on four quadrants:

  • Learning-oriented Tutorials provide hands-on lessons where users can learn the framework by doing.

  • Problem-oriented How-to Guides provide recipes to solve specific goals you may encounter while building a LoopBack project.

  • Understanding-oriented Concepts pages provide the explanation of architecture concepts, wider view and deeper knowledge about the framework.

  • Information-oriented Reference guides provide technical description of the machinery and how to use it.