Open
Conversation
jiangy10
force-pushed
the
main
branch
3 times, most recently
from
eba46bb to
5ae82c5
Compare
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -0,0 +1,38 @@ | |||
| # Test Lint Rule Levels | |||
Contributor
There was a problem hiding this comment.
Suggested change
| # Test Lint Rule Levels | |
| --- | |
| title: Test Lint Rule Levels | |
| description: This document demonstrates various markdown linting rule levels, outlining which infractions will fail a pull request as errors and which will only generate warnings. | |
| keywords: | |
| - markdown linting | |
| - error rules | |
| - warning rules | |
| - PR guidelines | |
| - lint violations | |
| --- | |
| # Test Lint Rule Levels |
| @@ -0,0 +1,53 @@ | |||
| # Test Lint Rules | |||
Contributor
There was a problem hiding this comment.
Suggested change
| # Test Lint Rules | |
| --- | |
| title: Test Lint Rules | |
| description: This document outlines various test cases designed to validate markdown linting rules, specifically focusing on heading usage, such as the correct application of h1 and lower-level headings. | |
| keywords: | |
| - markdown | |
| - lint rules | |
| - headings | |
| - h1 validation | |
| - test cases | |
| --- | |
| # Test Lint Rules |
| @@ -0,0 +1,38 @@ | |||
| # Test Lint Rule Levels | |||
Contributor
There was a problem hiding this comment.
Suggested change
| # Test Lint Rule Levels | |
| --- | |
| title: Test Lint Rule Levels | |
| description: This document showcases various markdown linting rule levels, highlighting examples of errors and warnings associated with common markdown lint rules. It details which rules will fail a pull request and which will merely show warnings. | |
| keywords: | |
| - markdown linting | |
| - error rules | |
| - warning rules | |
| - pull request | |
| - markdown syntax | |
| --- | |
| # Test Lint Rule Levels |
| @@ -0,0 +1,53 @@ | |||
| # Test Lint Rules | |||
Contributor
There was a problem hiding this comment.
Suggested change
| # Test Lint Rules | |
| --- | |
| title: Test Lint Rules | |
| description: This document outlines test cases for various markdown linting rules, focusing on proper heading levels and compliance with the no-multiple-h1 rule. It provides valid and invalid examples to illustrate correct markdown structure. | |
| keywords: | |
| - markdown | |
| - lint rules | |
| - headings | |
| - test cases | |
| - markdownlint | |
| --- | |
| # Test Lint Rules |
| @@ -0,0 +1,38 @@ | |||
| # Test Lint Rule Levels | |||
Contributor
There was a problem hiding this comment.
Suggested change
| # Test Lint Rule Levels | |
| --- | |
| title: Test Lint Rule Levels | |
| description: This document illustrates different levels of markdown linting rules, highlighting both error and warning rules using concrete examples, and summarizing which markdown formatting issues will fail or pass a pull request. | |
| keywords: | |
| - markdown linting | |
| - rule levels | |
| - errors | |
| - warnings | |
| - formatting | |
| --- | |
| # Test Lint Rule Levels |
| @@ -0,0 +1,53 @@ | |||
| # Test Lint Rules | |||
Contributor
There was a problem hiding this comment.
Suggested change
| # Test Lint Rules | |
| --- | |
| title: Test Lint Rules | |
| description: This document contains test cases to validate various markdown linting rules, focusing on heading structure and the enforcement of a single h1 heading. It includes both valid and invalid examples to illustrate correct and incorrect linting practices. | |
| keywords: | |
| - markdown | |
| - linting rules | |
| - headings | |
| - h1 enforcement | |
| - test cases | |
| --- | |
| # Test Lint Rules |
| @@ -0,0 +1,38 @@ | |||
| # Test Lint Rule Levels | |||
Contributor
There was a problem hiding this comment.
Suggested change
| # Test Lint Rule Levels | |
| --- | |
| title: Test Lint Rule Levels | |
| description: This document demonstrates various markdown linting rule levels, highlighting examples that trigger errors and warnings in markdown files, such as trailing spaces, multiple blanks, long lines, and duplicate headings. | |
| keywords: | |
| - markdown | |
| - linting | |
| - rule levels | |
| - errors | |
| - warnings | |
| --- | |
| # Test Lint Rule Levels |
| @@ -0,0 +1,53 @@ | |||
| # Test Lint Rules | |||
Contributor
There was a problem hiding this comment.
Suggested change
| # Test Lint Rules | |
| --- | |
| title: Test Lint Rules | |
| description: This document provides test cases to demonstrate the application and enforcement of various markdown linting rules, particularly focusing on heading structure, such as the correct use of h1 and subheadings. | |
| keywords: | |
| - markdown linting | |
| - heading rules | |
| - h1 heading | |
| - markdown test cases | |
| - lint validation | |
| --- | |
| # Test Lint Rules |
| @@ -0,0 +1,38 @@ | |||
| # Test Lint Rule Levels | |||
Contributor
There was a problem hiding this comment.
Suggested change
| # Test Lint Rule Levels | |
| --- | |
| title: Test Lint Rule Levels | |
| description: This document demonstrates various levels of markdown linting rules, categorizing them into errors that will fail a pull request and warnings that will merely display alerts. It provides examples of common lint rule violations and summarizes their impact. | |
| keywords: | |
| - markdown linting | |
| - error rules | |
| - warning rules | |
| - rule violations | |
| - documentation quality | |
| --- | |
| # Test Lint Rule Levels |
| @@ -0,0 +1,53 @@ | |||
| # Test Lint Rules | |||
Contributor
There was a problem hiding this comment.
Suggested change
| # Test Lint Rules | |
| --- | |
| title: Test Lint Rules | |
| description: This document provides various test cases for markdown linting rules, focusing primarily on the correct usage of heading levels, particularly ensuring only one H1 heading per file, and demonstrating valid and invalid heading structures. | |
| keywords: | |
| - markdown linting | |
| - heading rules | |
| - single H1 | |
| - valid examples | |
| - invalid examples | |
| --- | |
| # Test Lint Rules |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update the markdown files. and PR to test if this works for lint check.
Description
Related Issue
Motivation and Context
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Checklist: