langchain/docs/docs_skeleton
Jeremy W c5c0735fc4
Remove Evaluation from Modules page (#8926)
Remove Evaluation link (which gives 404 now) from Modules page, since it
lives under Guides page now
2023-08-08 10:20:24 -07:00
..
docs Remove Evaluation from Modules page (#8926) 2023-08-08 10:20:24 -07:00
src Add api cross ref linking (#8275) 2023-07-26 12:38:58 -07:00
static SQL use case docs (#8513) 2023-08-08 03:30:18 -07:00
.gitignore
babel.config.js
code-block-loader.js
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: Improvements on Mendable Search (#8808) 2023-08-06 15:32:06 -07:00
package.json docs: Improvements on Mendable Search (#8808) 2023-08-06 15:32:06 -07:00
README.md
settings.ini
sidebars.js use top nav docs (#8090) 2023-07-21 13:52:03 -07:00
vercel_build.sh Update local script for docs build (#8377) 2023-07-27 13:13:59 -07:00
vercel.json mv (#8595) 2023-08-01 14:17:04 -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