langchain/docs
Perry Lee 641e401ba8
Shorten wget commands (#14211)
- **Description:** The commands can be more efficient if the output name
is set to the destined filename instead of renaming in the second
command.
2023-12-04 12:03:47 -08:00
..
api_reference DOCS: core editable dep api refs (#13747) 2023-11-22 14:33:30 -08:00
docs Shorten wget commands (#14211) 2023-12-04 12:03:47 -08:00
scripts DOCS: format notebooks (#13371) 2023-11-14 14:17:44 -08:00
src docs[minor]: lcel why page (#14089) 2023-12-01 16:13:31 -08:00
static docs[patch]: update stack diagram (#13902) 2023-11-28 14:19:13 -08:00
.local_build.sh docs[minor]: lcel why page (#14089) 2023-12-01 16:13:31 -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]: added Templates Hub menu item (#14148) 2023-12-03 15:36:35 -08:00
package-lock.json docs[patch]: Add mermaid JS theme dependency to docusaurus (#14051) 2023-12-01 11:06:29 -08:00
package.json docs[patch]: Add mermaid JS theme dependency to docusaurus (#14051) 2023-12-01 11:06:29 -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 DOCS: move adapters to integrations (#13862) 2023-11-27 13:05:43 -08:00
vercel_build.sh docs[patch]: local docs build <5s (#14096) 2023-11-30 17:39:30 -08:00
vercel_requirements.txt docs[patch]: install local core (#13990) 2023-11-28 14:36:22 -08:00
vercel.json docs[patch]: AWS platform page update (#14160) 2023-12-03 15:42:52 -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