Frontmatter Metadata Guide
This document helps you quickly define core metadata for Dify developer documentation. Correctly filling out these fields is key to implementing automated document structure and sorting.
Quick Start
Prepare document content
Complete writing your document content.
Generate metadata with AI
Provide your document and the content from dimensions system explained to your preferred large language model, and request it to generate appropriate Frontmatter.
Manual refinement
Based on actual circumstances and the detailed explanations below, make necessary adjustments and optimizations to the generated metadata.
Prepare document content
Complete writing your document content.
Generate metadata with AI
Provide your document and the content from dimensions system explained to your preferred large language model, and request it to generate appropriate Frontmatter.
Manual refinement
Based on actual circumstances and the detailed explanations below, make necessary adjustments and optimizations to the generated metadata.
Read the detailed instructions below and define appropriate metadata fields based on the characteristics of your document content.
Required Frontmatter Fields
Please add the following YAML Frontmatter at the beginning of each Markdown document:
Understanding the dimensions Field
conceptual
Concepts, theory (what/why)
Focuses on explaining concepts and fundamental theories
implementation
Development practices, code (how to)
Focuses on providing implementation steps and code examples
operational
Operations, deployment (how to run)
Focuses on system operation and maintenance
reference
API, configuration reference (precise lookup)
Focuses on technical specifications and reference information
conceptual
Concepts, theory (what/why)
Focuses on explaining concepts and fundamental theories
implementation
Development practices, code (how to)
Focuses on providing implementation steps and code examples
operational
Operations, deployment (how to run)
Focuses on system operation and maintenance
reference
API, configuration reference (precise lookup)
Focuses on technical specifications and reference information
Subdivisions under the primary category:
Subdivisions under conceptual
Subdivisions under conceptual
introduction: Introductory contentprinciples: Design principlesarchitecture: Architectural explanation
Subdivisions under implementation
Subdivisions under implementation
basic: Basic implementationstandard: Standard implementationhigh: Higher-level implementation (may be deprioritized)advanced: Advanced implementation (may be deprioritized)
Subdivisions under operational
Subdivisions under operational
setup: Environment setupdeployment: Deployment operationsmaintenance: Maintenance management
Subdivisions under reference
Subdivisions under reference
core: Core referenceconfiguration: Configuration referenceexamples: Example reference
For more options, please refer to the dimensions system explained document
beginner
Newcomer
Content suitable for beginners
intermediate
Regular user
Content for users with some background knowledge
advanced
Advanced user
In-depth content for professional users (typically deprioritized in sorting)
Other Important Fields
Use English to clearly describe the core content of the document. The system will use this to generate part of the filename (e.g., Getting Started Dify Plugin).
ISO 639-2 two-letter language code (such as en, zh, ja).
The main title of the document displayed on the page, typically in the localized language.
A brief SEO description for search engines and previews.
Complete Examples
Example Interpretation: The first example is a beginner-oriented introductory document about Dify plugin concepts in English. The system will automatically place it correctly in the document structure based on the metadata.
Document Automation Processing
Run tools/main_docs_bundle.py, and the document will automatically complete the following operations based on the Frontmatter:
Rename Files
The system will automatically generate standardized filenames based on dimensions and standard_title.
Update Navigation
Documents will be automatically injected into the docs.json navigation configuration.
Add Interactive Components
Automatically refresh contribution and feedback buttons and other interactive components.
When developing documentation in a local environment, it’s recommended to run this script to ensure document configurations take effect correctly.
Run tools/main_docs_bundle.py, and the document will automatically complete the following operations based on the Frontmatter:
Rename Files
The system will automatically generate standardized filenames based on dimensions and standard_title.
Update Navigation
Documents will be automatically injected into the docs.json navigation configuration.
Add Interactive Components
Automatically refresh contribution and feedback buttons and other interactive components.
When developing documentation in a local environment, it’s recommended to run this script to ensure document configurations take effect correctly.
If you edit directly on GitHub, don’t worry about the automation steps. We have configured GitHub Actions and other automation tools to automatically execute tools/main_docs_bundle.py in the following situations:
- When you submit a Pull Request
- When your changes are merged into the main branch
You can focus on content creation, and the GitHub workflow will handle technical details such as file renaming, navigation updates, and interactive component generation.
Want to learn more?
If you’re interested in the design philosophy of the Dimensions system, the complete details of the sorting mechanism, or roles and governance, please read the full Dimensions system detailed explanation document.
Edit this page | Report an issue
Frontmatter Metadata Guide
This document helps you quickly define core metadata for Dify developer documentation. Correctly filling out these fields is key to implementing automated document structure and sorting.
Quick Start
Prepare document content
Complete writing your document content.
Generate metadata with AI
Provide your document and the content from dimensions system explained to your preferred large language model, and request it to generate appropriate Frontmatter.
Manual refinement
Based on actual circumstances and the detailed explanations below, make necessary adjustments and optimizations to the generated metadata.
Prepare document content
Complete writing your document content.
Generate metadata with AI
Provide your document and the content from dimensions system explained to your preferred large language model, and request it to generate appropriate Frontmatter.
Manual refinement
Based on actual circumstances and the detailed explanations below, make necessary adjustments and optimizations to the generated metadata.
Read the detailed instructions below and define appropriate metadata fields based on the characteristics of your document content.
Required Frontmatter Fields
Please add the following YAML Frontmatter at the beginning of each Markdown document:
Understanding the dimensions Field
conceptual
Concepts, theory (what/why)
Focuses on explaining concepts and fundamental theories
implementation
Development practices, code (how to)
Focuses on providing implementation steps and code examples
operational
Operations, deployment (how to run)
Focuses on system operation and maintenance
reference
API, configuration reference (precise lookup)
Focuses on technical specifications and reference information
conceptual
Concepts, theory (what/why)
Focuses on explaining concepts and fundamental theories
implementation
Development practices, code (how to)
Focuses on providing implementation steps and code examples
operational
Operations, deployment (how to run)
Focuses on system operation and maintenance
reference
API, configuration reference (precise lookup)
Focuses on technical specifications and reference information
Subdivisions under the primary category:
Subdivisions under conceptual
Subdivisions under conceptual
introduction: Introductory contentprinciples: Design principlesarchitecture: Architectural explanation
Subdivisions under implementation
Subdivisions under implementation
basic: Basic implementationstandard: Standard implementationhigh: Higher-level implementation (may be deprioritized)advanced: Advanced implementation (may be deprioritized)
Subdivisions under operational
Subdivisions under operational
setup: Environment setupdeployment: Deployment operationsmaintenance: Maintenance management
Subdivisions under reference
Subdivisions under reference
core: Core referenceconfiguration: Configuration referenceexamples: Example reference
For more options, please refer to the dimensions system explained document
beginner
Newcomer
Content suitable for beginners
intermediate
Regular user
Content for users with some background knowledge
advanced
Advanced user
In-depth content for professional users (typically deprioritized in sorting)
Other Important Fields
Use English to clearly describe the core content of the document. The system will use this to generate part of the filename (e.g., Getting Started Dify Plugin).
ISO 639-2 two-letter language code (such as en, zh, ja).
The main title of the document displayed on the page, typically in the localized language.
A brief SEO description for search engines and previews.
Complete Examples
Example Interpretation: The first example is a beginner-oriented introductory document about Dify plugin concepts in English. The system will automatically place it correctly in the document structure based on the metadata.
Document Automation Processing
Run tools/main_docs_bundle.py, and the document will automatically complete the following operations based on the Frontmatter:
Rename Files
The system will automatically generate standardized filenames based on dimensions and standard_title.
Update Navigation
Documents will be automatically injected into the docs.json navigation configuration.
Add Interactive Components
Automatically refresh contribution and feedback buttons and other interactive components.
When developing documentation in a local environment, it’s recommended to run this script to ensure document configurations take effect correctly.
Run tools/main_docs_bundle.py, and the document will automatically complete the following operations based on the Frontmatter:
Rename Files
The system will automatically generate standardized filenames based on dimensions and standard_title.
Update Navigation
Documents will be automatically injected into the docs.json navigation configuration.
Add Interactive Components
Automatically refresh contribution and feedback buttons and other interactive components.
When developing documentation in a local environment, it’s recommended to run this script to ensure document configurations take effect correctly.
If you edit directly on GitHub, don’t worry about the automation steps. We have configured GitHub Actions and other automation tools to automatically execute tools/main_docs_bundle.py in the following situations:
- When you submit a Pull Request
- When your changes are merged into the main branch
You can focus on content creation, and the GitHub workflow will handle technical details such as file renaming, navigation updates, and interactive component generation.
Want to learn more?
If you’re interested in the design philosophy of the Dimensions system, the complete details of the sorting mechanism, or roles and governance, please read the full Dimensions system detailed explanation document.
Edit this page | Report an issue