langchain/docs/docs_skeleton
Maciej Dzieżyc bcd308c368
Fix Open in Colab link for ClearML docs 2 (#11491)
Description: Fixed the Open in Colab link for ClearML docs
Issue: https://github.com/allegroai/clearml/issues/1125
Twitter handle: DziezycMaciej
2023-10-06 12:01:47 -07:00
..
docs Fix Open in Colab link for ClearML docs 2 (#11491) 2023-10-06 12:01:47 -07:00
src docs: Mendable Search Improvements (#11199) 2023-09-28 15:57:04 -07:00
static Update QA doc w/ Runnables (#11401) 2023-10-05 08:07:38 -07:00
.gitignore Doc refactor (#6300) 2023-06-16 11:52:56 -07:00
babel.config.js Doc refactor (#6300) 2023-06-16 11:52:56 -07:00
code-block-loader.js Doc refactor (#6300) 2023-06-16 11:52:56 -07:00
docusaurus.config.js rename repo namespace to langchain-ai (#11259) 2023-10-01 15:30:58 -04:00
ignore_build.sh fix prod docs build (#6402) 2023-06-18 20:56:12 -07:00
package-lock.json docs: Mendable Search Improvements (#11199) 2023-09-28 15:57:04 -07:00
package.json docs: Mendable Search Improvements (#11199) 2023-09-28 15:57:04 -07:00
README.md Doc refactor (#6300) 2023-06-16 11:52:56 -07:00
settings.ini Doc refactor (#6300) 2023-06-16 11:52:56 -07:00
sidebars.js mv LCEL up in docs (#11395) 2023-10-04 15:34:06 -04:00
vercel_build.sh mv docs extras (#11399) 2023-10-06 10:09:41 -07:00
vercel.json fix: Update Google Cloud Enterprise Search to Vertex AI Search (#10513) 2023-10-05 10:47:47 -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