Giter Club home page Giter Club logo

docs's Introduction

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.

Generating Python 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

Generating Javascript Docs

  1. Have chroma as a sibling to the the docs dir, eg
/docs
/chroma
  1. Update scripts/jsDocs.sh, sidebar.json if you need to expose more files other than Collection and Client

  2. Run yarn gen-js

docs's People

Contributors

jeffchuber avatar hammadb avatar tazarov avatar levand avatar swyxio avatar atroyn avatar sourishkrout avatar beggers avatar davelak avatar giuliohome avatar sweep-ai[bot] avatar fluder-paradyne avatar dbasch avatar nxp4code avatar russell-pollari avatar arnoldligtvoet avatar alw3ys avatar aevedis avatar kavinash-samsung avatar mcgeestocks avatar dgordonf avatar dglazkov avatar duarteocarmo avatar howdyhuang avatar jerryjliu avatar phrazzld avatar callmephilip avatar cakecrusher avatar sudhcha avatar dooart avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.