langchain/docs/docs_skeleton
2023-06-18 15:08:12 -07:00
..
docs fix link of callbacks on modules page (#6323) 2023-06-18 15:08:12 -07:00
src Doc refactor (#6300) 2023-06-16 11:52:56 -07:00
static Doc refactor (#6300) 2023-06-16 11:52:56 -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 Doc refactor (#6300) 2023-06-16 11:52:56 -07:00
ignore_build.sh Add ignore vercel preview script (#6320) 2023-06-17 11:17:08 -07:00
package.json Doc refactor (#6300) 2023-06-16 11:52:56 -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 update api link (#6303) 2023-06-16 12:18:17 -07:00
vercel_build.sh Doc refactor (#6300) 2023-06-16 11:52:56 -07:00
vercel.json more redirect (#6314) 2023-06-16 14:43:59 -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