cobra icon indicating copy to clipboard operation
cobra copied to clipboard

Published 20 hours ago • verified publisher icon spf13

Fix markdownlint errors at 'doc'

Open erdaltsksn opened this issue 2 years ago • 3 comments

Fixed rules:

  • MD010 - Hard tabs
  • MD040 - Fenced code blocks should have a language specified
  • MD041 - First line in a file should be a top-level heading

see: https://github.com/DavidAnson/markdownlint#rules--aliases

erdaltsksn avatar Jul 03 '22 14:07 erdaltsksn

Thanks for this PR! Can you provide a bit more info on what this PR is doing?

Seems that this fixes some errors from mdlint that the MD docs generation automatically create?

It'd also be useful to provide a sample program and it's output when generating the docs so we can evaluate it.

I've created a simple CLI application and show markdown generate diff in the following commit: https://github.com/erdaltsksn/playground/commit/bef3d2de7f8ba4de0f662293dd8a1ae57afd8dc7

erdaltsksn avatar Jul 15 '22 19:07 erdaltsksn

The Cobra project currently lacks enough contributors to adequately respond to all PRs. This bot triages issues and PRs according to the following rules:

  • After 60d of inactivity, lifecycle/stale is applied. - After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied and the PR is closed. You can:
  • Make a comment to remove the stale label and show your support. The 60 days reset. - If a PR has lifecycle/rotten and is closed, comment and ask maintainers if they'd be interseted in reopening.

github-actions[bot] avatar Sep 17 '22 00:09 github-actions[bot]

The Cobra project currently lacks enough contributors to adequately respond to all PRs. This bot triages issues and PRs according to the following rules:

  • After 60d of inactivity, lifecycle/stale is applied. - After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied and the PR is closed. You can:
  • Make a comment to remove the stale label and show your support. The 60 days reset. - If a PR has lifecycle/rotten and is closed, comment and ask maintainers if they'd be interseted in reopening.

Up

erdaltsksn avatar Sep 20 '22 09:09 erdaltsksn

The Cobra project currently lacks enough contributors to adequately respond to all PRs. This bot triages issues and PRs according to the following rules:

  • After 60d of inactivity, lifecycle/stale is applied. - After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied and the PR is closed. You can:
  • Make a comment to remove the stale label and show your support. The 60 days reset. - If a PR has lifecycle/rotten and is closed, comment and ask maintainers if they'd be interseted in reopening.

github-actions[bot] avatar Nov 21 '22 00:11 github-actions[bot]

The Cobra project currently lacks enough contributors to adequately respond to all PRs. This bot triages issues and PRs according to the following rules:

  • After 60d of inactivity, lifecycle/stale is applied. - After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied and the PR is closed. You can:
  • Make a comment to remove the stale label and show your support. The 60 days reset. - If a PR has lifecycle/rotten and is closed, comment and ask maintainers if they'd be interseted in reopening.

up

erdaltsksn avatar Dec 04 '22 03:12 erdaltsksn

This is really cool, thanks @erdaltsksn!

I think you also need to fix: MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] rule.

Would really appreciate if you can check this and give a go ahead.

Dentrax avatar Feb 28 '23 14:02 Dentrax