Skip to content
This repository has been archived by the owner on Oct 11, 2021. It is now read-only.

DescriptionValidMarkdownHeading

Gary Ewan Park edited this page Dec 10, 2020 · 5 revisions

CPMR0030 - Description Valid Markdown Heading

Issue

The Description element of the package nuspec file contains invalid Markdown headings. For example, you may have this:

###This is my heading

instead of:

### This is my heading

Recommended Solution

Please update the description element of the nuspec file to contain valid Markdown Headings. More information can be found here.

Reasoning

The Chocolatey Community Repository uses the Markdig Library for parsing/rendering Markdown content. When invalid headings are used, the result looks like the following:

image

A prior version of the Chocolatey Community Repository did support this way for writing headings, but it is not part of the official Markdown specification, and as such, we don't want any further invalid headings making their way into the repository.

Remember!!

Always push the exact same version of the package during review! Package versions are not immutable until approved.

Requirements

Guidelines

Suggestions

Notes

Clone this wiki locally