Skip to content

Commit 6f1a444

Browse files
committed
Address errors based on the new markdonwlint config
1 parent b9e921b commit 6f1a444

28 files changed

+252
-218
lines changed

MARKDOWNLINT_RULES.md

Lines changed: 47 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,11 @@ This directory contains markdown linting configuration for the App Builder docum
99
The `.markdownlint.json` file configures markdown-lint with rules suitable for technical documentation and DocFX compatibility:
1010

1111
### Enabled Rules
12-
<!-- - **MD001**: Heading levels should only increment by one level at a time
13-
- **MD003**: Heading style (ATX style with #) -->
14-
<!-- - **MD004**: Unordered list style (dash) -->
15-
<!-- - **MD007**: Unordered list indentation (2 spaces) -->
12+
13+
- **MD001**: Heading levels should only increment by one level at a time
14+
- **MD003**: Heading style (ATX style with #)
15+
- **MD004**: Unordered list style (dash)
16+
- **MD007**: Unordered list indentation (2 spaces)
1617
- **MD009**: Trailing spaces (allow 2 for line breaks)
1718
- **MD010**: Hard tabs
1819
- **MD012**: Multiple consecutive blank lines (max 2)
@@ -22,10 +23,10 @@ The `.markdownlint.json` file configures markdown-lint with rules suitable for t
2223
- **MD022**: Headings should be surrounded by blank lines
2324
- **MD023**: Headings must start at the beginning of the line
2425
- **MD024**: Multiple headings with the same content (allow different nesting)
26+
- **MD025**: Multiple top-level headings in same document (front_matter_title handled)
2527
- **MD026**: Trailing punctuation in heading
2628
- **MD027**: Multiple spaces after blockquote symbol
27-
<!-- - **MD028**: Blank line inside blockquote
28-
- **MD029**: Ordered list item prefix (ordered style) -->
29+
- **MD029**: Ordered list item prefix (ordered style)
2930
- **MD030**: Spaces after list markers
3031
- **MD031**: Fenced code blocks should be surrounded by blank lines
3132
- **MD032**: Lists should be surrounded by blank lines
@@ -35,30 +36,24 @@ The `.markdownlint.json` file configures markdown-lint with rules suitable for t
3536
- **MD039**: Spaces inside link text
3637
- **MD042**: No empty links
3738
- **MD045**: Images should have alternate text (alt text)
38-
<!-- - **MD046**: Code block style (fenced) -->
39+
- **MD046**: Code block style (fenced)
3940
- **MD047**: Files should end with a single newline character
4041
- **MD048**: Code fence style (backtick)
4142
- **MD049**: Emphasis style (underscore)
4243
- **MD050**: Strong style (asterisk)
44+
- **MD055**: Table pipe style (leading and trailing)
4345

4446
### Disabled Rules
4547

46-
- **MD001**: Heading levels increment (disabled - documentation may skip heading levels for layout)
47-
- **MD003**: Heading style (disabled - allows both ATX and Setext styles)
48-
- **MD004**: Unordered list style (disabled - allows both dash and asterisk styles for international docs)
49-
- **MD007**: Unordered list indentation (disabled - flexible indentation for complex lists)
5048
- **MD013**: Line length (disabled - technical docs have long URLs/code examples)
51-
- **MD025**: Multiple top-level headings (disabled - allows multiple H1 headers for DocFX frontmatter)
5249
- **MD028**: Blank line inside blockquote (disabled - allows flexible blockquote formatting)
53-
- **MD029**: Ordered list item prefix (disabled - allows flexible numbering in documentation)
5450
- **MD033**: Inline HTML (disabled - allows HTML tags needed for DocFX)
5551
- **MD034**: Bare URLs (disabled - allows bare URLs as we use many reference links)
5652
- **MD036**: Emphasis used instead of heading (disabled - allows emphasis used as headers for styling)
5753
- **MD040**: Fenced code blocks should have a language specified (disabled - would be noisy)
5854
- **MD041**: First line in a file should be a top-level heading (disabled - not always applicable with frontmatter)
5955
- **MD043**: Required heading structure (disabled - too restrictive)
6056
- **MD044**: Proper names should have the correct capitalization (disabled - would require extensive config)
61-
- **MD046**: Code block style (disabled - allows both fenced and indented code blocks)
6257

6358
## Usage
6459

@@ -125,6 +120,8 @@ npm run verify
125120
- Trailing spaces (MD009)
126121
- Missing blank lines around headers, lists, code blocks (MD022, MD031, MD032)
127122
- Inconsistent list markers (MD004)
123+
- Inconsistent heading styles (MD003)
124+
- List indentation (MD007)
128125
- File ending newlines (MD047)
129126
- Header spacing issues (MD018, MD019)
130127
- Some emphasis and code span formatting (MD037, MD038)
@@ -134,31 +131,63 @@ npm run verify
134131
- **All spelling errors** (cspell has no auto-fix feature)
135132
- Complex markdown structure issues
136133
- Content-related problems
137-
- Heading hierarchy problems (MD001)
138-
- Line length issues (MD013)
134+
- Heading hierarchy problems (MD001) - need to add intermediate heading levels
135+
- Ordered list numbering (MD029) - may need to indent content to maintain list context
136+
- Multiple top-level headings (MD025) - need to demote additional H1s to H2
137+
- Code block style (MD046) - need to convert indented blocks to fenced blocks
139138

140139
## Common Issues and Fixes
141140

142141
### MD001 - Heading increment
143142

144143
**Issue**: Jumping from `##` to `####`
145-
**Fix**: Use `###` instead
144+
**Fix**: Use `###` instead - headings should only increment by one level at a time
145+
146+
### MD003 - Heading style
147+
148+
**Issue**: Mixing ATX (`#`) and Setext (underline) heading styles
149+
**Fix**: Use ATX style (`#`, `##`, `###`) consistently
150+
151+
### MD004 - Unordered list style
152+
153+
**Issue**: Mixing `-`, `*`, or `+` for list items
154+
**Fix**: Use dash (`-`) consistently for unordered lists
155+
156+
### MD007 - Unordered list indentation
157+
158+
**Issue**: Incorrect indentation in nested lists
159+
**Fix**: Use 2 spaces for nested list items
146160

147161
### MD009 - Trailing spaces
148162

149163
**Issue**: Unnecessary trailing spaces at end of line
150-
**Fix**: Remove trailing spaces (except when intentional for line breaks)
164+
**Fix**: Remove trailing spaces (except when intentional for line breaks with 2 spaces)
151165

152166
### MD022 - Headings surrounded by blank lines
153167

154168
**Issue**: No blank line before/after heading
155169
**Fix**: Add blank lines around headings
156170

171+
### MD025 - Multiple top-level headings
172+
173+
**Issue**: Multiple `#` headings in same document
174+
**Fix**: Use only one H1 per document (frontmatter title doesn't count)
175+
176+
### MD029 - Ordered list item prefix
177+
178+
**Issue**: Inconsistent or incorrect numbering like `1. 2. 4.` or using all `1.` items
179+
**Fix**: Use sequential numbering `1. 2. 3.` for ordered lists
180+
157181
### MD031 - Code blocks surrounded by blank lines
158182
159183
**Issue**: No blank line before/after code fence
160184
**Fix**: Add blank lines around code blocks
161185
186+
### MD046 - Code block style
187+
188+
**Issue**: Using indented code blocks (4 spaces) instead of fenced blocks
189+
**Fix**: Use fenced code blocks with triple backticks (```)
190+
162191
### MD047 - File should end with newline
163192
164193
**Issue**: No newline at end of file

en/app-themes/app-themes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ _keywords: App Builder themes, Indigo Design, Infragistics
88

99
An app theme is a collection of color palettes and attributes that create a sense of visual persistency throughout the entire app, view, or activity. With app themes, you can define the look and feel of your application by selecting and configuring different panels, styles, layouts, typography, pre-built theme widgets. Or you can create a custom theme file too.
1010

11-
# App Builder themes
11+
## App Builder themes
1212

1313
> [!Video https://www.youtube.com/embed/gcTyeFp_65c?si=w-3ycuuDZ4whrEZc&list=UULF8cj8_eJROxAXsOjhbvduLw]
1414

en/blazor-support.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ You can generate both Blazor Web Assembly or Blazor Server apps based on your pr
2020
> [!NOTE]
2121
><b>Trying to generate code for components not available yet will put a placeholder informing that such a component is not yet supported. This makes it possible for you not to refrain from developing more complex UI in the designer.
2222
23-
### In this article
23+
## In this article
2424

2525
- <a href="#introduction">Introduction of the feature</a>
2626
- <a href="#blazor-code-generation">Blazor Code generation</a>

en/flex-layouts/flex-layouts.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ _keywords: App builder flex layouts, Indigo Design, Infragistics
66

77
# Flex layouts (and positioning)
88

9-
### What is Flex layout?
9+
## What is Flex layout?
1010

1111
Flex layout is used for component positioning, space distribution between items, and resizing. It provides powerful alignment capabilities, lays out elements in either columns or rows, and helps you build responsive page layouts that easily adapt to any screen size.
1212

13-
### How to use Flex layout?
13+
## How to use Flex layout?
1414

1515
In essence, the Flex layout is designed to enable developers to easily specify the sizing of a layout container, define visibilities and viewport sizes, and respectively shrink or expand items in order to best fit into the available space.
1616

1717
In order to achieve all of this, the first thing you have to do when using Flex layout is to target the container or parent element and adjust the CSS of your container elements.
1818

19-
### How to create Flex layouts in App Builder?
19+
## How to create Flex layouts in App Builder?
2020

2121
In order to use the Flex layout in the App Builder, you need to define a container (which in the video is referred to as canvas). Note that it has its display property automatically set to Flex. Go to Views, add new container, choose Flex layout row or Flex layout column.
2222

en/generate-app/azure-integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Soon, you’ll be able to deploy your app to **Azure Web Apps** directly from Ap
6161
- Will support both **standard** and **static web apps**
6262
- Simplifies deployment for customer demos and staging environments
6363

64-
# How Microsoft Account Types Impact Authentication
64+
## How Microsoft Account Types Impact Authentication
6565

6666
When connecting Azure DevOps to App Builder, authentication is handled via Microsoft Entra ID (formerly Azure Active Directory). Account type directly impacts the success of this connection.
6767

en/generate-app/run-application-locally.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ _keywords: App Builder, Web App Builder, Design Systems, Design Systems UX, UI k
55
---
66
# Run Application Locally
77

8-
### Run the app locally
8+
## Run the app locally
99

1010
To finally develop the app, you don't need to copy and paste code. Instead, use the generate app button in the toolbar. This quickly creates a package with your Angular or Blazor application (depending on what framework is selected in the Platform picker dropdown) that can be downloaded. To run this app, open up the folder in an IDE like Visual Studio Code.
1111

en/generate-app/upload-application-to-github.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ _keywords: App Builder, Web App Builder, Design Systems, Design Systems UX, UI k
88
> [!NOTE]
99
><b>Once ready with your design in App Builder you can upload it to your private or GitHub repository.
1010
11-
12-
### In this article
11+
## In this article
1312

1413
- <a href="#intro">Introduction of the feature</a>
1514
- <a href="#uploading-an-application-to-github">Uploading an application to GitHub</a>

en/guide-to-variables-in-app-builder/component-properties-binding.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@ Consider a scenario where you have a collection of movies and wish to display de
2424
<img src="../images/state-and-context/4.png" srcset="../images/state-and-context/4.png 2x" />
2525
<p style="text-align:center;">Array type variable</p>
2626

27-
2. **Create an Array Variable**: Set up an empty Array variable named "Box Office Revenue". The Data Type is automatically determined based on the data source of the Combo component.
27+
1. **Create an Array Variable**: Set up an empty Array variable named "Box Office Revenue". The Data Type is automatically determined based on the data source of the Combo component.
2828

29-
<img src="../images/state-and-context/10.png" srcset="../images/state-and-context/10.png 2x" />
30-
<p style="text-align:center;">New Variable dialog</p>
29+
<img src="../images/state-and-context/10.png" srcset="../images/state-and-context/10.png 2x" />
30+
<p style="text-align:center;">New Variable dialog</p>
3131

32-
3. **Bind to a Card Component**: Link the "selectedMovies" variable to a card component. Bind the Title and Subtitle properties to the appropriate data fields from the Data Context.
32+
2. **Bind to a Card Component**: Link the "selectedMovies" variable to a card component. Bind the Title and Subtitle properties to the appropriate data fields from the Data Context.
3333

34-
<img src="../images/state-and-context/11.png" srcset="../images/state-and-context/11.png 2x" />
35-
<p style="text-align:center;">Data context binding</p>
34+
<img src="../images/state-and-context/11.png" srcset="../images/state-and-context/11.png 2x" />
35+
<p style="text-align:center;">Data context binding</p>
3636

3737
The result is a dynamically updated card component based on your selection:
3838

en/interactions.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ _keywords: App Builder, Web App Builder, Design Systems, Design Systems UX, UI k
88
> [!NOTE]
99
> The Interactions feature of the App Builder enables users to define particular interactions between views and components, such as Navigate to another view, Show or Hide and Open or Close an app component.
1010
11-
12-
### In this article
11+
## In this article
1312

1413
- <a href="#intro">Introduction of the feature</a>
1514
- <a href="#navigate-to">Interaction: Navigate to</a>

en/master-detail/step-by-step-examples.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,17 @@ Global variable set from one View and Updating Grid request from another View th
2323
3. Go to the other view, where the Grid is bound to an API request fetching orders based on that CustomerID
2424
4. The Grid should be updated with the selected CustomerID (from the Combo)
2525

26-
<img src="../images/state-and-context/18.png" srcset="../images/state-and-context/18.png 2x" />
27-
<p style="text-align:center;">Selection Changed event</p>
26+
<img src="../images/state-and-context/18.png" srcset="../images/state-and-context/18.png 2x" />
27+
<p style="text-align:center;">Selection Changed event</p>
2828

29-
<img src="../images/state-and-context/20.png" srcset="../images/state-and-context/20.png 2x" />
30-
<p style="text-align:center;">CustomerID Variable</p>
29+
<img src="../images/state-and-context/20.png" srcset="../images/state-and-context/20.png 2x" />
30+
<p style="text-align:center;">CustomerID Variable</p>
3131

3232
5. Upon clicking on Order from the Orders grid, load another Grid with OrderDetails
3333
6. Result
3434

35-
<img src="../images/state-and-context/21.png" srcset="../images/state-and-context/21.png 2x" />
36-
<p style="text-align:center;">Result</p>
35+
<img src="../images/state-and-context/21.png" srcset="../images/state-and-context/21.png 2x" />
36+
<p style="text-align:center;">Result</p>
3737

3838
## Example 2
3939

@@ -44,27 +44,27 @@ Tree bound to Hierarchical data source loading data for Grid and Chart
4444
1. Add a Tree component and bind its parent to a Hierarchical data source (Repeated data context).
4545
2. Bind the parent tree node On Click event to a Set variable action that stores the CustomerID - String variable
4646

47-
<img src="../images/state-and-context/22.png" srcset="../images/state-and-context/22.png 2x" />
48-
<p style="text-align:center;">Tree node binding</p>
47+
<img src="../images/state-and-context/22.png" srcset="../images/state-and-context/22.png 2x" />
48+
<p style="text-align:center;">Tree node binding</p>
4949

5050
3. Add a Tree child node and repeat to the Parent data context. Bind the child tree node On Click event to a Set variable action that stores the OrderID - Number variable
5151

52-
<img src="../images/state-and-context/23.png" srcset="../images/state-and-context/23.png 2x" />
53-
<p style="text-align:center;">Child node binding</p>
52+
<img src="../images/state-and-context/23.png" srcset="../images/state-and-context/23.png 2x" />
53+
<p style="text-align:center;">Child node binding</p>
5454

5555
4. Ensure the root tree element shows the Customer and the child tree node shows the Orders
5656

5757
5. Bind a Grid to an endpoint that fetches Orders based on the OrderID variable as a query param
5858

59-
<img src="../images/state-and-context/24.png" srcset="../images/state-and-context/24.png 2x" />
60-
<p style="text-align:center;">Bind Grid to Orders data</p>
59+
<img src="../images/state-and-context/24.png" srcset="../images/state-and-context/24.png 2x" />
60+
<p style="text-align:center;">Bind Grid to Orders data</p>
6161

6262
6. Bind the Chart to an endpoint that fetches Customer orders history based on the CustomerID variable as a query param
6363

64-
<img src="../images/state-and-context/25.png" srcset="../images/state-and-context/25.png 2x" />
65-
<p style="text-align:center;">Bind Chart to Customer Orders History table</p>
64+
<img src="../images/state-and-context/25.png" srcset="../images/state-and-context/25.png 2x" />
65+
<p style="text-align:center;">Bind Chart to Customer Orders History table</p>
6666

6767
7. Result
6868

69-
<img src="../images/state-and-context/26.png" srcset="../images/state-and-context/26.png 2x" />
70-
<p style="text-align:center;">Tree + Grid + Chart Result</p>
69+
<img src="../images/state-and-context/26.png" srcset="../images/state-and-context/26.png 2x" />
70+
<p style="text-align:center;">Tree + Grid + Chart Result</p>

0 commit comments

Comments
 (0)