Skip to main content

Documentation - Development

The documentation and packages are kept in a separate repository. Clone the repo with the URL below.

Installation​

Clone the repo and then navigate into the project folder.

git clone https://github.com/OpenBB-finance/openbb-docs.git

Packages should be installed within your OpenBB Platform Python environment.

Node.js​

  • Node.js >= 16.13.0 To check if Node.js installed, run this command:
node --version # should be v16.13.0 or higher

Install Dependencies​

npm install

Generate Markdown Files​

Markdown files for the Reference and Data Models pages need to be generated. This will generate content based on what is actually installed and contained locally, so it may appear different than what is on this website.

Run the command below from the root of the repository.

python scripts/generate_platform_markdown.py

Start Development Server​

npm start

This starts a local development server at: http://localhost:3000

Most changes are reflected live without having to restart the server.

Build​

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

OpenBB uses Github Pages to host our website, it's deployed in the gh-pages branch.

On this page