langchain/docs
Nuno Campos 2719e49718
Add how-to guide on runnable generators (#12135)
<!-- Thank you for contributing to LangChain!

Replace this entire comment with:
  - **Description:** a description of the change, 
  - **Issue:** the issue # it fixes (if applicable),
  - **Dependencies:** any dependencies required for this change,
- **Tag maintainer:** for a quicker response, tag the relevant
maintainer (see below),
- **Twitter handle:** we announce bigger features on Twitter. If your PR
gets announced, and you'd like a mention, we'll gladly shout you out!

Please make sure your PR is passing linting and testing before
submitting. Run `make format`, `make lint` and `make test` to check this
locally.

See contribution guidelines for more information on how to write/run
tests, lint, etc:

https://github.com/langchain-ai/langchain/blob/master/.github/CONTRIBUTING.md

If you're adding a new integration, please include:
1. a test for the integration, preferably unit tests that do not rely on
network access,
2. an example notebook showing its use. It lives in `docs/extras`
directory.

If no one reviews your PR within a few days, please @-mention one of
@baskaryan, @eyurtsev, @hwchase17.
 -->
2023-10-22 19:02:17 +01:00
..
api_reference Add runnables to api reference (#11520) 2023-10-17 11:46:08 -04:00
docs Add how-to guide on runnable generators (#12135) 2023-10-22 19:02:17 +01:00
docs_skeleton/docs Google Scholar Search Tool using serpapi (#11513) 2023-10-20 17:35:55 -04:00
extras/guides/langsmith Bagatur/mv singlestore doc (#12053) 2023-10-19 15:06:26 -07:00
scripts Restructure docs (#11620) 2023-10-10 12:55:19 -07:00
src add cookbook table (#12043) 2023-10-19 14:05:24 -07:00
static Docs: QA Privacy Nit (#12025) 2023-10-19 09:43:47 -04:00
.local_build.sh add cookbook table (#12043) 2023-10-19 14:05:24 -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 RM snippets (#11798) 2023-10-15 12:20:58 -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 Add security.md (#11881) 2023-10-16 17:41:21 -04:00
vercel_build.sh add cookbook table (#12043) 2023-10-19 14:05:24 -07:00
vercel_requirements.txt
vercel.json feat: Google Vertex AI Search Retriever - Add support for Website Data Stores (#11736) 2023-10-18 23:41:48 -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