You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/ai-services/document-intelligence/concept/markdown-elements.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,19 @@
1
1
---
2
-
title: Document Intelligence Supported Markdown Elements
2
+
title: Document Intelligence supported markdown elements
3
3
titleSuffix: Azure AI services
4
4
description: Description of the supported markdown elements returned as part of the Layout API response and how to use the response in your applications.
5
5
author: laujan
6
6
manager: nitinme
7
7
ms.service: azure-ai-document-intelligence
8
8
ms.topic: conceptual
9
-
ms.date: 04/24/2025
9
+
ms.date: 05/05/2025
10
10
ms.author: tonyeiyalla
11
11
12
12
---
13
13
14
14
# Understanding Document Intelligence Layout API Markdown Output Format
15
15
16
-
Azure AI Document Intelligence's Layout API can transform your documents into rich markdown, preserving their original structure and formatting. Simply specify outputContentFormat=markdown in your request to receive semantically structured content that maintains paragraphs, headings, tables, and other document elements in their proper hierarchy.
16
+
Azure AI Document Intelligence Layout API can transform your documents into rich markdown, preserving their original structure and formatting. Just specify `outputContentFormat=markdown` in your request to receive semantically structured content that maintains paragraphs, headings, tables, and other document elements in their proper hierarchy.
17
17
18
18
This markdown output elegantly captures the document's original organization while providing standardized, easily consumable content for downstream applications. The preserved semantic structure enables more sophisticated document processing workflows without losing the context and relationships between document elements.
19
19
@@ -42,7 +42,7 @@ Paragraphs represent cohesive blocks of text that belong together semantically.
42
42
* Using line breaks within paragraphs to maintain the visual structure of the original document
43
43
* Maintaining proper text flow that respects the original document's reading order
44
44
45
-
Here is an example:
45
+
Here's an example:
46
46
47
47
```md
48
48
This is paragraph 1.
@@ -54,12 +54,12 @@ This is paragraph 2. There is a blank line between paragraph 1 and paragraph 2.
54
54
55
55
### Heading
56
56
57
-
Headings organize document content into a hierarchical structure, making navigation and understanding easier. The Layout API:
57
+
Headings organize document content into a hierarchical structure to make navigation and understanding easier. The Layout API has the following capabilities:
58
58
59
-
* Uses standard markdown heading syntax with 1-6 hash symbols (#) corresponding to heading levels
60
-
* Maintains proper spacing with two blank lines before each heading for improved readability
59
+
* Uses standard markdown heading syntax with 1-6 hash symbols (#) corresponding to heading levels.
60
+
* Maintains proper spacing with two blank lines before each heading for improved readability.
61
61
62
-
Here is an example:
62
+
Here's an example:
63
63
64
64
```md
65
65
# This is a title
@@ -84,7 +84,7 @@ Tables preserve complex structured data in a visually organized format. The Layo
84
84
* Maintains proper spacing with two blank lines before each table for improved readability
85
85
* Preserves table footnotes as separate paragraph following the table
86
86
87
-
Here is an example:
87
+
Here's an example:
88
88
89
89
```md
90
90
<table>
@@ -108,7 +108,7 @@ The Layout API preserves figure elements:
108
108
* Preserves figure captions with the `<figcaption>` tag to provide important context
109
109
* Preserves figure footnotes as separate paragraphs following the figure container
110
110
111
-
Here is an example:
111
+
Here's an example:
112
112
113
113
```md
114
114
<figure>
@@ -146,7 +146,7 @@ Mathematical formulas are preserved with LaTeX-compatible syntax that allows for
146
146
* Multi-line formulas are represented as consecutive block formulas, preserving mathematical relationships
147
147
* Original spacing and formatting are maintained to ensure accurate representation
148
148
149
-
Here is an example of inline formula, single-line formula block and multiple-lines formula block:
149
+
Here's an example of inline formula, single-line formula block and multiple-lines formula block:
150
150
151
151
```md
152
152
The mass-energy equivalence formula $E = m c ^ { 2 }$ is an example of an inline formula
@@ -160,13 +160,13 @@ $$= \exp \left[ - \sum _ { k = 1 } ^ { j - 1 } \beta _ { k , k + 1 } \Delta E _
160
160
161
161
### Barcode
162
162
163
-
Barcodes and QR codes are represented using markdown image syntax with additional semantic information:
163
+
Barcodes and QR codes are represented using markdown image syntax with added semantic information:
164
164
165
165
* Uses standard image markdown syntax with descriptive attributes
166
166
* Captures both the barcode type (QR code, barcode, etc.) and its encoded value
167
167
* Preserves the semantic relationship between barcodes and surrounding content
0 commit comments