langchain/docs/docs_skeleton
2023-07-03 07:59:11 -07:00
..
docs Add JSON Lines support to JSONLoader (#6913) 2023-07-02 12:32:41 -07:00
src
static
.gitignore
babel.config.js
code-block-loader.js
docusaurus.config.js docs: commented out editUrl option (#6440) 2023-07-03 07:59:11 -07:00
ignore_build.sh fix prod docs build (#6402) 2023-06-18 20:56:12 -07:00
package.json
README.md
settings.ini
sidebars.js update api link (#6303) 2023-06-16 12:18:17 -07:00
vercel_build.sh
vercel.json Redirect vecstores (#6948) 2023-06-29 19:22: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