You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
langchain/docs/docs_skeleton
Davis Chase 2eea5d4cb4
Add ignore vercel preview script (#6320)
skip building preview of docs for anything branch that doesn't start
with `__docs__`. will eventually update to look at code diff directories
but patching for now
12 months ago
..
docs fix links to prompt templates and example selectors (#6332) 12 months ago
src Doc refactor (#6300) 12 months ago
static Doc refactor (#6300) 12 months ago
.gitignore Doc refactor (#6300) 12 months ago
README.md Doc refactor (#6300) 12 months ago
babel.config.js Doc refactor (#6300) 12 months ago
code-block-loader.js Doc refactor (#6300) 12 months ago
docusaurus.config.js Doc refactor (#6300) 12 months ago
ignore_build.sh Add ignore vercel preview script (#6320) 12 months ago
package.json Doc refactor (#6300) 12 months ago
settings.ini Doc refactor (#6300) 12 months ago
sidebars.js update api link (#6303) 12 months ago
vercel.json more redirect (#6314) 12 months ago
vercel_build.sh Doc refactor (#6300) 12 months ago

README.md

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