langchain/docs
Leonid Ganeline d9bfdc95ea
docs[patch]: google platform page update (#14475)
Added missed tools

---------

Co-authored-by: Erick Friis <erickfriis@gmail.com>
2023-12-08 17:40:44 -08:00
..
api_reference API Reference building script update (#13587) 2023-12-07 11:43:42 -08:00
docs docs[patch]: google platform page update (#14475) 2023-12-08 17:40:44 -08:00
scripts DOCS: format notebooks (#13371) 2023-11-14 14:17:44 -08:00
src docs[patch]: search experiment (#14254) 2023-12-04 16:58:26 -08:00
static docs[patch]: update stack diagram (#13902) 2023-11-28 14:19:13 -08:00
.local_build.sh core[patch], langchain[patch]: ByteStore (#14312) 2023-12-06 10:05:43 -08:00
babel.config.js Restructure docs (#11620) 2023-10-10 12:55:19 -07:00
code-block-loader.js Restructure docs (#11620) 2023-10-10 12:55:19 -07:00
docusaurus.config.js docs[patch]: search experiment (#14254) 2023-12-04 16:58:26 -08:00
package-lock.json docs[patch]: search experiment (#14254) 2023-12-04 16:58:26 -08:00
package.json docs[patch]: search experiment (#14254) 2023-12-04 16:58:26 -08:00
README.md Fix typos (#11663) 2023-10-12 11:44:03 -04:00
settings.ini Restructure docs (#11620) 2023-10-10 12:55:19 -07:00
sidebars.js core[patch], langchain[patch]: ByteStore (#14312) 2023-12-06 10:05:43 -08:00
vercel_build.sh nbdoc -> quarto (#14156) 2023-12-04 12:50:56 -08:00
vercel_requirements.txt nbdoc -> quarto (#14156) 2023-12-04 12:50:56 -08:00
vercel.json docs[patch]: moved vectorstore notebook file (#14181) 2023-12-04 14:44:06 -08:00

Website

This website is built using Docusaurus 2, a modern static website generator.

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.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

Continuous Integration

Some common defaults for linting/formatting have been set for you. If you integrate your project with an open-source Continuous Integration system (e.g. Travis CI, CircleCI), you may check for issues using the following command.

$ yarn ci