Skip to content

chore: Fix Markdownlint warnings#277

Merged
kzantow merged 1 commit intospdx:mainfrom
bact:fix-markdown-header
Jan 16, 2026
Merged

chore: Fix Markdownlint warnings#277
kzantow merged 1 commit intospdx:mainfrom
bact:fix-markdown-header

Conversation

@bact
Copy link
Contributor

@bact bact commented Jan 16, 2026

  • Use Markdown frontmatter (between two --- lines) for SPDX-License-Identifier metadata at the top of file
    • To fix Markdownlint warning "MD041/first-line-heading/first-line-h1: First line in a file should be a top-level heading"
    • This convention is supported by GitHub (as well as other static website generators) and the metadata will be displayed as a table
  • Add language tag to code block in README

- Use Markdown frontmatter (between two `---` lines) for SPDX-License-Identifier metadata at the top of file
  - To fix Markdownlint warning "MD041/first-line-heading/first-line-h1: First line in a file should be a top-level heading"
  - This convention is supported by GitHub (as well as other static website generators) and the metadata will be displayed as a table
- Add language tag to code block in README

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@kzantow kzantow merged commit 435b9ea into spdx:main Jan 16, 2026
6 checks passed
@bact bact deleted the fix-markdown-header branch January 16, 2026 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants