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
Bagatur bfbb97b74c
Bagatur/deeplake docs fixes (#9275)
Co-authored-by: adilkhan <adilkhan.sarsen@nu.edu.kz>
1 year ago
..
docs nit (#9243) 1 year ago
src Add api cross ref linking (#8275) 1 year ago
static Added new use case docs for Web Scraping, Chromium loader, BS4 transformer (#8732) 1 year ago
.gitignore Doc refactor (#6300) 1 year ago
README.md Doc refactor (#6300) 1 year ago
babel.config.js Doc refactor (#6300) 1 year ago
code-block-loader.js Doc refactor (#6300) 1 year ago
docusaurus.config.js Automatically set docs appearance to system default (#8924) 1 year ago
generate_api_reference_links.py fix links generation (#8471) 1 year ago
ignore_build.sh fix prod docs build (#6402) 1 year ago
package-lock.json docs: (Mendable Search) Fixes stuck when tabbing out issue (#9074) 1 year ago
package.json docs: (Mendable Search) Fixes stuck when tabbing out issue (#9074) 1 year ago
settings.ini Doc refactor (#6300) 1 year ago
sidebars.js Add docs community page (#8992) 1 year ago
vercel.json Bagatur/deeplake docs fixes (#9275) 1 year ago
vercel_build.sh Update local script for docs build (#8377) 1 year 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