Markdown Cheat Sheet

Markdown cheat sheet with real commands and snippets for setup, core workflows, debugging, and production-safe automation patterns. If you are working across tools, pair this with the YAML Cheat Sheet and Kotlin Cheat Sheet.

Setup and Validation

Goal: Run formatters and linters for content files

# Format project files when formatter is available
npx prettier -w . || true

# Lint Markdown/YAML/JSON if linters exist
npx markdownlint-cli2 '**/*.md' || npx yaml-language-server --help || true

# Search for TODO placeholders before publish
rg "TODO|TBD" .

Core Patterns

Goal: Use a production-safe snippet

# API Notes

Use the [curl cheat sheet](/curl) for HTTP examples.

## Steps

1. Authenticate with a token.
2. Send a request.
3. Store the response.

```bash
curl -H "Authorization: Bearer $TOKEN" https://api.example.com/me

## Automation and CI

### Goal: Add validation step to CI pipeline

```bash
# Run strict shell mode in CI
set -euo pipefail

# Validate syntax and formatting in one pass
npx prettier -c .

# Fail build if broken references exist
rg "](/[^)]+)" src/content -n

Debugging and Troubleshooting

Goal: Track parse failures quickly

# Use ripgrep to isolate malformed syntax
rg "{{|}}|<[^>]*$" src -n

# Print files with potential encoding issues
file -I src/content/sheets/*.md

# Re-run formatter with explicit parser
npx prettier --parser markdown src/content/sheets/*.md || true

Common Gotchas

• Keep Markdown content valid and machine-readable for build pipelines.
• Avoid trailing commas or comments in strict JSON files.
• Use consistent heading depth to keep TOC generation stable.
• Prefer explicit encoding (UTF-8) for portability.
• Run formatter checks before committing content edits.

Related Sheets

• YAML Cheat Sheet — daily YAML commands and production-ready examples.
• Kotlin Cheat Sheet — daily Kotlin commands and production-ready examples.
• LaTeX Cheat Sheet — daily LaTeX commands and production-ready examples.