langchain/docs
2023-10-13 13:58:26 -07:00
..
api_reference fix api docs build (#11445) 2023-10-05 15:33:11 -07:00
docs fix recent docs integrations file loc (#11782) 2023-10-13 13:58:26 -07:00
docs_skeleton/docs/guides/langsmith add ls guide redirect (#11623) 2023-10-10 12:58:04 -07:00
extras/guides/langsmith fix recent docs integrations file loc (#11782) 2023-10-13 13:58:26 -07:00
scripts Restructure docs (#11620) 2023-10-10 12:55:19 -07:00
snippets mv self-query docs to integrations (#11744) 2023-10-12 22:36:07 -07:00
src Start cookbook and move stuff from use cases (#11636) 2023-10-11 12:27:13 -07:00
static Qa with anonymization (#11658) 2023-10-11 15:38:08 -07:00
.local_build.sh Restructure docs (#11620) 2023-10-10 12:55:19 -07: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 collapse sidebar peer items (#11639) 2023-10-10 19:56:21 -07:00
package-lock.json Restructure docs (#11620) 2023-10-10 12:55:19 -07: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 Restructure docs (#11620) 2023-10-10 12:55:19 -07:00
vercel_build.sh Restructure docs (#11620) 2023-10-10 12:55:19 -07:00
vercel_requirements.txt
vercel.json mv self-query docs to integrations (#11744) 2023-10-12 22:36:07 -07: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