Guidelines for developing and maintaining Langflow documentation using Docusaurus, including content structure, style, and deployment processes.
Sign in to like and favorite skills
description: "Guidelines for developing and maintaining Langflow documentation using Docusaurus, including content structure, style, and deployment processes." globs:
Guidelines for developing and maintaining Langflow documentation using Docusaurus, including content structure, style, and deployment processes.
cd docs yarn install # Install dependencies yarn start # Start dev server (usually port 3001)
docs/docs/ ├── docs/ # Main documentation content │ ├── agents/ # Agent and MCP guides │ ├── get-started/ # Getting started guides │ ├── tutorials/ # Langflow tutorials │ ├── components/ # Component documentation │ ├── flows/ # Guides to build, run, and test flows │ ├── deployment/ # Guides for deploying and hosting a Langflow server │ ├── develop/ # Guides for developing apps with Langflow │ ├── support/ # Help and release notes │ ├── contributing/ # Contribution guidelines │ └── api-reference/ # API documentation ├── src/ # Custom React components ├── static/ # Static assets (images, etc.) ├── sidebars.js # Sidebar configuration ├── docusaurus.config.js # Main configuration └── package.json # Dependencies
docs/getting-started/docs/api-reference/docs/components/blog/--- title: Page Title description: Brief description for SEO sidebar_position: 1 --- # Page Title Brief introduction paragraph. ## Section Header Content with proper formatting. ### Subsection More detailed content. :::tip Use admonitions for important information. ::: :::warning Use warnings for potential issues. ::: :::danger Use danger for critical warnings. :::
```python title="component_example.py" from langflow.components.base import Component class MyComponent(Component): display_name = "My Component" description = "Example component" def run(self): return "Hello, World!" ```
<!-- Images go in static/img/ -->  <!-- Use descriptive alt text --> 
--- title: Component Name description: Brief description of what the component does sidebar_position: 1 --- # Component Name Brief overview of the component's purpose. ## Overview What this component does and when to use it. ## Configuration ### Inputs | Input | Type | Required | Description | |-------|------|----------|-------------| | `input_text` | String | Yes | The text to process | | `model_name` | String | No | Model to use (default: gpt-3.5-turbo) | ### Outputs | Output | Type | Description | |--------|------|-------------| | `result` | Message | Processed result | ## Usage Example ```python # Example of using the component component = MyComponent( input_text="Hello, world!", model_name="gpt-4" ) result = component.run()
Solution: Check that all required inputs are provided.
Solution: Ensure your API key is properly configured.
### API Documentation ```markdown --- title: API Endpoint description: REST API endpoint documentation --- # API Endpoint Name ## Endpoint `POST /api/v1/endpoint` ## Request ### Headers ```json { "Authorization": "Bearer <token>", "Content-Type": "application/json" }
{ "parameter": "value", "optional_param": "optional_value" }
{ "success": true, "data": { "result": "success" } }
{ "success": false, "error": "Error message" }
curl -X POST http://localhost:7860/api/v1/endpoint \ -H "Authorization: Bearer your-token" \ -H "Content-Type: application/json" \ -d '{"parameter": "value"}'
--- ## 5. Blog Posts and Announcements ### Blog Post Template ```markdown --- title: "Release: Langflow v1.1.0" description: "New features and improvements in Langflow v1.1.0" authors: [author-name] date: 2024-01-15 tags: [release, features] --- # Release: Langflow v1.1.0 Brief introduction to the release. ## New Features ### Feature 1 Description of the feature and how to use it. ### Feature 2 Another feature description. ## Improvements - List of improvements - Bug fixes - Performance enhancements ## Breaking Changes :::warning List any breaking changes that require user action. ::: ## Migration Guide Steps to migrate from previous versions.
--- title: "Announcement: New Integration" description: "Langflow now supports integration with XYZ service" authors: [author-name] date: 2024-01-15 tags: [announcement, integration] --- Brief announcement content with clear call-to-action.
sidebars.jsmodule.exports = { docs: [ 'introduction', { type: 'category', label: 'Getting Started', items: [ 'getting-started/installation', 'getting-started/quickstart', 'getting-started/first-flow', ], }, { type: 'category', label: 'Components', items: [ 'components/overview', 'components/inputs', 'components/outputs', 'components/processing', ], }, ], };
docusaurus.config.jsmodule.exports = { title: 'Langflow Documentation', tagline: 'Build AI flows visually', url: 'https://docs.langflow.org', baseUrl: '/', themeConfig: { navbar: { title: 'Langflow', logo: { alt: 'Langflow Logo', src: 'img/logo.svg', }, items: [ { type: 'doc', docId: 'introduction', position: 'left', label: 'Docs', }, { to: '/blog', label: 'Blog', position: 'left' }, ], }, }, };
# Check for broken internal links yarn build yarn serve # Manual testing or use link checker tools
backticksyarn build # Build static site yarn serve # Serve built site locally
build/yarn startyarn build