langchain/docs
2023-11-27 12:56:15 -08:00
..
api_reference DOCS: core editable dep api refs (#13747) 2023-11-22 14:33:30 -08:00
docs DOCS: fix link to question answering (#13806) 2023-11-27 12:56:15 -08:00
scripts DOCS: format notebooks (#13371) 2023-11-14 14:17:44 -08:00
src add cookbook table (#12043) 2023-10-19 14:05:24 -07:00
static DOCS: update rag use case images (#13615) 2023-11-20 10:14:52 -08:00
.local_build.sh Harrison/docs smith serve (#12898) 2023-11-06 07:07:25 -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 FEAT docs integration cards site (#13379) 2023-11-14 19:49:17 -08:00
package-lock.json Upgrade docs postcss (#13031) 2023-11-07 15:50:25 -08:00
package.json Restructure docs (#11620) 2023-10-10 12:55:19 -07: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 template readme's in docs (#13152) 2023-11-09 23:36:21 -08:00
vercel_build.sh template readme's in docs (#13152) 2023-11-09 23:36:21 -08:00
vercel_requirements.txt Add api cross ref linking (#8275) 2023-07-26 12:38:58 -07:00
vercel.json DOCS updated async-faiss example (#13434) 2023-11-16 17:41:26 -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