langflow/docs
Mendon Kissling 26ed6dc2f7
docs: API examples (#5499)
* bump-api-to-1.1.1

* docs: api reference content

* more-endpoints

* cleanup

* all-endpoints-accounted-for

* docs: update API reference with user response examples and authorization header

* all-200s-complete

* fix-spacing-for-gh-preview

* sidebars

* monitor-endpoints

* fix-build-error

* fix-sidebar-error

* create-flows

* flows-endpoint-finished

* move

* files-endpoint

* run-flow

* folder-endpoint

* docs: update API reference with new endpoints and examples for flows, folders, and files

* value

* docs: update openapi.json

* docs: enhance API reference with folder-id export instructions and examples

* docs: update API reference with new flow structure and log retrieval instructions

* docs: clarify ZIP file download endpoint description in API examples

* docs: refine API examples for clarity and consistency

* docs: refine API examples for clarity and consistency

* webhook

* docs: format curl example for improved readability

* docs: update curl examples to use double quotes for variable interpolation

* docs: Update API example descriptions for improved clarity

* docs: Update API example descriptions for improved clarity

* docs: Enhance API reference with Langflow API key setup and build flow examples

* docs: update API reference examples with new event data and structure

* docs: add clarification on LLM chat response streaming in API examples

* error-and-build-vertex

* docs: remove wrong information from API examples

* Apply suggestions from code review

Co-authored-by: KimberlyFields <46325568+KimberlyFields@users.noreply.github.com>

* docs: Update API reference examples for environment variable exports

* docs: Fix JSON structure in API reference examples

* docs: Update API reference examples for file download and log retrieval

---------

Co-authored-by: anovazzi1 <otavio2204@gmail.com>
Co-authored-by: Gabriel Luiz Freitas Almeida <gabriel@langflow.org>
Co-authored-by: KimberlyFields <46325568+KimberlyFields@users.noreply.github.com>
2025-01-15 17:10:05 +00:00
..
css docs: replace documentation icon and primary color (#4582) 2024-11-14 09:58:42 +00:00
docs docs: API examples (#5499) 2025-01-15 17:10:05 +00:00
i18n docs: added fetching from notion (#2670) 2024-07-12 22:59:52 +02:00
src docs: add icons component with lucide-react integration (#4682) 2024-11-18 09:55:02 -08:00
static Docs: components updates (#5315) 2024-12-20 21:39:29 +00:00
.gitignore docs: reuploaded old images that were referenced (#2673) 2024-07-12 21:32:53 +00:00
babel.config.js add docs with components 2023-07-18 15:08:00 -03:00
docusaurus.config.js docs: remove Guides, add pages on other categories, add Types (#4881) 2025-01-03 16:58:29 +00:00
index.d.ts docs: added fetching from notion (#2670) 2024-07-12 22:59:52 +02:00
openapi.json docs: API examples (#5499) 2025-01-15 17:10:05 +00:00
package-lock.json docs: rename getting-started folder and add redirects (#4813) 2024-11-25 20:26:58 +00:00
package.json docs: rename getting-started folder and add redirects (#4813) 2024-11-25 20:26:58 +00:00
README.md add docs with components 2023-07-18 15:08:00 -03:00
sidebars.js docs: API examples (#5499) 2025-01-15 17:10:05 +00:00
tsconfig.json docs: added fetching from notion (#2670) 2024-07-12 22:59:52 +02:00
yarn.lock docs: rename getting-started folder and add redirects (#4813) 2024-11-25 20:26:58 +00: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.