Markdown

6 items tagged with "markdown"

Filter by type:

Standards1

CommonMark 0.30

Adhering to the CommonMark standard during software migrations is crucial for maintaining consistent formatting and compatibility across platforms. This comprehensive guide outlines the importance of CommonMark, key requirements for compliance, and practical steps to ensure your content meets the standard, ultimately enhancing collaboration and reducing errors in documentation.

Best Practices1

Best Practice

Documentation as Code

Documentation as Code treats docs like software: stored in version control, written in plain text, reviewed in pull requests, and published automatically through continuous integration.

Tutorials2

Tutorial

Comment Drift Results on Pull Requests

Generate a Markdown drift report with the Vibgrate CLI and post it as a pull request comment so reviewers see the DriftScore in context.

Tutorial

Generate a Human-Readable Drift Report with vg report

Turn raw scan artifacts into a shareable Markdown, text, or JSON drift report using vg report so stakeholders can read your DriftScore at a glance.

FAQs2

FAQ

What output formats does the scan support?

Four formats: Text (default, colored human-readable), JSON (full artifact for automation), SARIF (for GitHub Code Scanning, Azure DevOps), and Markdow...

FAQ

How do I generate reports from existing scans?

Use vg report to render existing scan artifacts into different formats without re-scanning. By default, it reads .vibgrate/scan_result.json. Use --in ...