Skip to content

Commit 014a20a

Browse files
committed
resolve PR review feedback
1 parent d3466c5 commit 014a20a

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

articles/ai-services/document-intelligence/concept/markdown-elements.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Document Intelligence supported markdown elements
2+
title: Document Intelligence supported Markdown elements
33
titleSuffix: Azure AI services
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.
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.
55
author: laujan
66
manager: nitinme
77
ms.service: azure-ai-document-intelligence
@@ -13,14 +13,14 @@ ms.author: tonyeiyalla
1313

1414
# Understanding Document Intelligence Layout API Markdown Output Format
1515

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.
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.
1717

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.
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.
1919

2020

2121
## Markdown elements supported in Layout Analysis
2222

23-
The following markdown elements are included in Layout API responses:
23+
The following Markdown elements are included in Layout API responses:
2424

2525
* Paragraph
2626
* Heading
@@ -46,7 +46,7 @@ Here's an example:
4646

4747
``` md
4848
This is paragraph 1.
49-
This is still paragraph 1, even if in another markdown line.
49+
This is still paragraph 1, even if in another Markdown line.
5050

5151
This is paragraph 2. There is a blank line between paragraph 1 and paragraph 2.
5252
```
@@ -56,7 +56,7 @@ This is paragraph 2. There is a blank line between paragraph 1 and paragraph 2.
5656

5757
Headings organize document content into a hierarchical structure to make navigation and understanding easier. The Layout API has the following capabilities:
5858

59-
* Uses standard markdown heading syntax with 1-6 hash symbols (#) corresponding to heading levels.
59+
* Uses standard Markdown heading syntax with 1-6 hash symbols (#) corresponding to heading levels.
6060
* Maintains proper spacing with two blank lines before each heading for improved readability.
6161

6262
Here's an example:
@@ -77,7 +77,7 @@ Here's an example:
7777

7878
Tables preserve complex structured data in a visually organized format. The Layout API uses HTML table syntax for maximum fidelity and compatibility:
7979

80-
* Implements full HTML table markup (`<table>`, `<tr>`, `<th>`, `<td>`) rather than standard markdown tables
80+
* Implements full HTML table markup (`<table>`, `<tr>`, `<th>`, `<td>`) rather than standard Markdown tables
8181
* Preserves merged cell with HTML rowspan and colspan attributes.
8282
* Preserves table captions with the `<caption>` tag to maintain document context
8383
* Handles complex table structures including headers, cells, and footers
@@ -160,9 +160,9 @@ $$= \exp \left[ - \sum _ { k = 1 } ^ { j - 1 } \beta _ { k , k + 1 } \Delta E _
160160

161161
### Barcode
162162

163-
Barcodes and QR codes are represented using markdown image syntax with added semantic information:
163+
Barcodes and QR codes are represented using Markdown image syntax with added semantic information:
164164

165-
* Uses standard image markdown syntax with descriptive attributes
165+
* Uses standard image Markdown syntax with descriptive attributes
166166
* Captures both the barcode type (QR code, barcode, etc.) and its encoded value
167167
* Preserves the semantic relationship between barcodes and surrounding content
168168

@@ -181,7 +181,7 @@ Here's an example:
181181

182182
Page metadata elements provide context about document pagination but aren't meant to be displayed inline with the main content:
183183

184-
* Enclosed in HTML comments to preserve the information while keeping it hidden from standard markdown rendering
184+
* Enclosed in HTML comments to preserve the information while keeping it hidden from standard Markdown rendering
185185
* Maintains original page structure information that might be valuable for document reconstruction
186186
* Enables applications to understand document pagination without disrupting the content flow
187187

@@ -211,7 +211,8 @@ Here's an example:
211211
For KeyValuePairs/Language/Style, we map them to Analytics JSON body and not in the Markdown content.
212212

213213

214-
**NOTE:** Markdown reference - [GitHub Flavored Markdown Spec](https://github.github.com/gfm)
214+
> [!NOTE]
215+
> For more information on Markdown that is currently supported for user content on GitHub.com, *see* [GitHub Flavored Markdown Spec](https://github.github.com/gfm).
215216
216217
## Conclusion
217218

0 commit comments

Comments
 (0)