langchain/docs/docs_skeleton
Bagatur 1fb7bdd595
Split sql use case docs (#10257)
Split sql use case into directory so we can add other structured data
pages
2023-09-06 16:19:21 -07:00
..
docs Split sql use case docs (#10257) 2023-09-06 16:19:21 -07:00
src 📖 docs: compact api reference (#8651) 2023-08-24 09:01:52 -07:00
static Update agent docs, move to use-case sub-directory (#9344) 2023-08-25 11:28:55 -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 Automatically set docs appearance to system default (#8924) 2023-08-08 09:54:18 -07:00
generate_api_reference_links.py fix links generation (#8471) 2023-07-29 18:31:33 -07:00
ignore_build.sh fix prod docs build (#6402) 2023-06-18 20:56:12 -07:00
package-lock.json docs: (Mendable Search) Fixes stuck when tabbing out issue (#9074) 2023-08-10 13:46:06 -07:00
package.json docs: (Mendable Search) Fixes stuck when tabbing out issue (#9074) 2023-08-10 13:46:06 -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 docs up a level (#10073) 2023-09-01 08:20:55 -07:00
vercel_build.sh Update local script for docs build (#8377) 2023-07-27 13:13:59 -07:00
vercel.json Split sql use case docs (#10257) 2023-09-06 16:19:21 -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