mirror of
https://github.com/Mintplex-Labs/langchainjs.git
synced 2026-07-18 17:54:35 -04:00
Sean Sullivan
f02042d899
* fix: add initial documentation with typedoc * feat: add docusaurus (#17) * feat: add docusaurus * fix: update docs * Cleanup docs (#19) * Create Guides category, sort out sidebars * remove generated files * Set up ghpages deployment * Change deployment method * Temporarily make it run on any push * Fix api docs broken links, clean up the api docs output a bit * Revert "Temporarily make it run on any push" This reverts commit 423c15686c675e9410e311760f7c7934071eb84c. --------- Co-authored-by: Nuno Campos <nuno@boringbits.io> * Harrison/add getting started (#20) * fix: add initial documentation with typedoc * feat: add docusaurus * fix: update docs * Create Guides category, sort out sidebars * remove generated files * Set up ghpages deployment * Change deployment method * Temporarily make it run on any push * feat: add docusaurus (#17) * feat: add docusaurus * fix: update docs * Cleanup docs (#19) * Create Guides category, sort out sidebars * remove generated files * Set up ghpages deployment * Change deployment method * Temporarily make it run on any push * Fix api docs broken links, clean up the api docs output a bit * Revert "Temporarily make it run on any push" This reverts commit 423c15686c675e9410e311760f7c7934071eb84c. --------- Co-authored-by: Nuno Campos <nuno@boringbits.io> * cr * cr * cr * cr * cr * fix: remove max-len lint rule * cr --------- Co-authored-by: Sean Sullivan <ssullivan61198@gmail.com> Co-authored-by: Nuno Campos <nuno@boringbits.io> Co-authored-by: Sean Sullivan <22581534+sullivan-sean@users.noreply.github.com> * cr --------- Co-authored-by: Nuno Campos <nuno@boringbits.io> Co-authored-by: Harrison Chase <hw.chase.17@gmail.com>
1.0 KiB
1.0 KiB
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