Skip to content

Latest commit

 

History

History
43 lines (26 loc) · 775 Bytes

README.md

File metadata and controls

43 lines (26 loc) · 775 Bytes
Raw

Chroma docs

These docs are built using Docusaurus 2

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

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

Regenerating API Docs

  1. Have chroma as a sibling to the the docs dir, eg
/docs
/chroma

  1. Update pydoc-markdown.yml if you need to expose more files other than Collection and Client

  2. Run yarn gen-python

Deployment

Vercel handles deploying main to https://docs.trychroma.com