To view the documentation please visit docs.openfn.org.
Documentation for various OpenFn tools, such as openfn/microservice, openfn/devtools, openfn/core, and all of our open-source adaptors can be found in OpenFn's Github organization.
This repository is used to maintain the docs site, and for users to submit issues and feature requests.
Visit https://docs.openfn.org/documentation/writing-docs/.
This website is built using Docusaurus 2, a modern static website generator.
- To create new docs pages, add markdown files (or JS files) to the
/docs
folder. - To view those new pages via the navigation, add links to them in the header, footer, or sidebars.
- Note that page ids (which are required in
sidebar.js
are either set explicitly or automatically generated by docusaurus as the filename, sans extension.)
./sidebars.js
./sidebars-library.js
./docusaurs.config.js
Installation
yarn install
(On Mac, I first had to run npm install --global yarn
and then run this^
command in the /docs
repo.)
npm run start
This command builds the job library from OpenFn.org, starts a local development server, and opens up a browser window. Most changes are reflected live without having to restart the server.
npm run start-offline
This command skips the job library step, which requires an active internet connection.
npm run generate-library
npm run build
npm run serve
This command generates static content into the build
directory and can be
served using any static contents hosting service.
Builds to main
will automatically be deployed to
docs.openfn.org.