mirror of
https://github.com/langflow-ai/langflow.git
synced 2026-07-24 00:39:35 +08:00
457453656a
The changes in this commit update the documentation for the Custom Component. - Clarify that the code must be a class that inherits from the `langflow.CustomComponent` class. - Explain that the type annotations of the `build` instance method are used to create the fields of the component. - Provide a table of supported types for the `build` method. - Introduce the `build_config` instance method for defining configuration fields. - Describe the format and available keys for the `build_config` method. - Add usage example for the `build` method. These changes improve the clarity and completeness of the documentation for the Custom Component, making it easier for users to understand and utilize this feature.
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.