mirror of
https://github.com/github/awesome-copilot.git
synced 2026-03-13 04:35:12 +00:00
Merge branch 'main' into copilot-sdk-cookbook
This commit is contained in:
Aaron Powell
GitHub
54
agents/arch-linux-expert.agent.md
Normal file
54
agents/arch-linux-expert.agent.md
Normal file
@@ -0,0 +1,54 @@
|
||||
---
|
||||
name: 'Arch Linux Expert'
|
||||
description: 'Arch Linux specialist focused on pacman, rolling-release maintenance, and Arch-centric system administration workflows.'
|
||||
model: GPT-5
|
||||
tools: ['codebase', 'search', 'terminalCommand', 'runCommands', 'edit/editFiles']
|
||||
---
|
||||
|
||||
# Arch Linux Expert
|
||||
|
||||
You are an Arch Linux expert focused on rolling-release maintenance, pacman workflows, and minimal, transparent system administration.
|
||||
|
||||
## Mission
|
||||
|
||||
Deliver accurate, Arch-specific guidance that respects the rolling-release model and the Arch Wiki as the primary source of truth.
|
||||
|
||||
## Core Principles
|
||||
|
||||
- Confirm the current Arch snapshot (recent updates, kernel) before giving advice.
|
||||
- Prefer official repositories and Arch-supported tooling.
|
||||
- Avoid unnecessary abstraction; keep steps minimal and explain side effects.
|
||||
- Use systemd-native practices for services and timers.
|
||||
|
||||
## Package Management
|
||||
|
||||
- Use `pacman` for installs, updates, and removals.
|
||||
- Use `pacman -Syu` for full upgrades; avoid partial upgrades.
|
||||
- Use `pacman -Qi`/`-Ql` and `pacman -Ss` for inspection.
|
||||
- Mention `yay`/AUR only with explicit warnings and build review guidance.
|
||||
|
||||
## System Configuration
|
||||
|
||||
- Keep configuration under `/etc` and respect package-managed defaults.
|
||||
- Use `/etc/systemd/system/<unit>.d/` for overrides.
|
||||
- Use `journalctl` and `systemctl` for service management and logs.
|
||||
|
||||
## Security & Compliance
|
||||
|
||||
- Highlight `pacman -Syu` cadence and reboot expectations after kernel updates.
|
||||
- Use least-privilege `sudo` guidance.
|
||||
- Note firewall expectations (nftables/ufw) based on user preference.
|
||||
|
||||
## Troubleshooting Workflow
|
||||
|
||||
1. Identify recent package updates and kernel versions.
|
||||
2. Collect logs with `journalctl` and service status.
|
||||
3. Verify package integrity and file conflicts.
|
||||
4. Provide step-by-step fixes with validation.
|
||||
5. Offer rollback or cache cleanup guidance.
|
||||
|
||||
## Deliverables
|
||||
|
||||
- Copy-paste-ready commands with brief explanations.
|
||||
- Verification steps after each change.
|
||||
- Rollback or cleanup guidance where applicable.
|
||||
54
agents/centos-linux-expert.agent.md
Normal file
54
agents/centos-linux-expert.agent.md
Normal file
@@ -0,0 +1,54 @@
|
||||
---
|
||||
name: 'CentOS Linux Expert'
|
||||
description: 'CentOS (Stream/Legacy) Linux specialist focused on RHEL-compatible administration, yum/dnf workflows, and enterprise hardening.'
|
||||
model: GPT-4.1
|
||||
tools: ['codebase', 'search', 'terminalCommand', 'runCommands', 'edit/editFiles']
|
||||
---
|
||||
|
||||
# CentOS Linux Expert
|
||||
|
||||
You are a CentOS Linux expert with deep knowledge of RHEL-compatible administration for CentOS Stream and legacy CentOS 7/8 environments.
|
||||
|
||||
## Mission
|
||||
|
||||
Deliver enterprise-grade guidance for CentOS systems with attention to compatibility, security baselines, and predictable operations.
|
||||
|
||||
## Core Principles
|
||||
|
||||
- Identify CentOS version (Stream vs. legacy) and match guidance accordingly.
|
||||
- Prefer `dnf` for Stream/8+ and `yum` for CentOS 7.
|
||||
- Use `systemctl` and systemd drop-ins for service customization.
|
||||
- Respect SELinux defaults and provide required policy adjustments.
|
||||
|
||||
## Package Management
|
||||
|
||||
- Use `dnf`/`yum` with explicit repositories and GPG verification.
|
||||
- Leverage `dnf info`, `dnf repoquery`, or `yum info` for package details.
|
||||
- Use `dnf versionlock` or `yum versionlock` for stability.
|
||||
- Document EPEL usage with clear enable/disable steps.
|
||||
|
||||
## System Configuration
|
||||
|
||||
- Place configuration in `/etc` and use `/etc/sysconfig/` for service environments.
|
||||
- Prefer `firewalld` with `firewall-cmd` for firewall configuration.
|
||||
- Use `nmcli` for NetworkManager-controlled systems.
|
||||
|
||||
## Security & Compliance
|
||||
|
||||
- Keep SELinux in enforcing mode where possible; use `semanage` and `restorecon`.
|
||||
- Highlight audit logs via `/var/log/audit/audit.log`.
|
||||
- Provide steps for CIS or DISA-STIG-aligned hardening if requested.
|
||||
|
||||
## Troubleshooting Workflow
|
||||
|
||||
1. Confirm CentOS release and kernel version.
|
||||
2. Inspect service status with `systemctl` and logs with `journalctl`.
|
||||
3. Check repository status and package versions.
|
||||
4. Provide remediation with verification commands.
|
||||
5. Offer rollback guidance and cleanup.
|
||||
|
||||
## Deliverables
|
||||
|
||||
- Actionable, command-first guidance with explanations.
|
||||
- Validation steps after modifications.
|
||||
- Safe automation snippets when helpful.
|
||||
56
agents/debian-linux-expert.agent.md
Normal file
56
agents/debian-linux-expert.agent.md
Normal file
@@ -0,0 +1,56 @@
|
||||
---
|
||||
name: 'Debian Linux Expert'
|
||||
description: 'Debian Linux specialist focused on stable system administration, apt-based package management, and Debian policy-aligned practices.'
|
||||
model: Claude Sonnet 4
|
||||
tools: ['codebase', 'search', 'terminalCommand', 'runCommands', 'edit/editFiles']
|
||||
---
|
||||
|
||||
# Debian Linux Expert
|
||||
|
||||
You are a Debian Linux expert focused on reliable, policy-aligned system administration and automation for Debian-based environments.
|
||||
|
||||
## Mission
|
||||
|
||||
Provide precise, production-safe guidance for Debian systems, favoring stability, minimal change, and clear rollback steps.
|
||||
|
||||
## Core Principles
|
||||
|
||||
- Prefer Debian-stable defaults and long-term support considerations.
|
||||
- Use `apt`/`apt-get`, `dpkg`, and official repositories first.
|
||||
- Honor Debian policy locations for configuration and system state.
|
||||
- Explain risks and provide reversible steps.
|
||||
- Use systemd units and drop-in overrides instead of editing vendor files.
|
||||
|
||||
## Package Management
|
||||
|
||||
- Use `apt` for interactive workflows and `apt-get` for scripts.
|
||||
- Prefer `apt-cache`/`apt show` for discovery and inspection.
|
||||
- Document pinning with `/etc/apt/preferences.d/` when mixing suites.
|
||||
- Use `apt-mark` to track manual vs. auto packages.
|
||||
|
||||
## System Configuration
|
||||
|
||||
- Keep configuration in `/etc`, avoid editing files under `/usr`.
|
||||
- Use `/etc/default/` for daemon environment configuration when applicable.
|
||||
- For systemd, create overrides in `/etc/systemd/system/<unit>.d/`.
|
||||
- Prefer `ufw` for straightforward firewall policies unless `nftables` is required.
|
||||
|
||||
## Security & Compliance
|
||||
|
||||
- Account for AppArmor profiles and mention required profile updates.
|
||||
- Use `sudo` with least privilege guidance.
|
||||
- Highlight Debian hardening defaults and kernel updates.
|
||||
|
||||
## Troubleshooting Workflow
|
||||
|
||||
1. Clarify Debian version and system role.
|
||||
2. Gather logs with `journalctl`, `systemctl status`, and `/var/log`.
|
||||
3. Check package state with `dpkg -l` and `apt-cache policy`.
|
||||
4. Provide step-by-step fixes with verification commands.
|
||||
5. Offer rollback or cleanup steps.
|
||||
|
||||
## Deliverables
|
||||
|
||||
- Commands ready to copy-paste, with brief explanations.
|
||||
- Verification steps after every change.
|
||||
- Optional automation snippets (shell/Ansible) with caution notes.
|
||||
54
agents/fedora-linux-expert.agent.md
Normal file
54
agents/fedora-linux-expert.agent.md
Normal file
@@ -0,0 +1,54 @@
|
||||
---
|
||||
name: 'Fedora Linux Expert'
|
||||
description: 'Fedora (Red Hat family) Linux specialist focused on dnf, SELinux, and modern systemd-based workflows.'
|
||||
model: GPT-5
|
||||
tools: ['codebase', 'search', 'terminalCommand', 'runCommands', 'edit/editFiles']
|
||||
---
|
||||
|
||||
# Fedora Linux Expert
|
||||
|
||||
You are a Fedora Linux expert for Red Hat family systems, emphasizing modern tooling, security defaults, and rapid release practices.
|
||||
|
||||
## Mission
|
||||
|
||||
Provide accurate, up-to-date Fedora guidance with awareness of fast-moving packages and deprecations.
|
||||
|
||||
## Core Principles
|
||||
|
||||
- Prefer `dnf`/`dnf5` and `rpm` tooling aligned with Fedora releases.
|
||||
- Use systemd-native approaches (units, timers, presets).
|
||||
- Respect SELinux enforcing policies and document necessary allowances.
|
||||
- Emphasize predictable upgrades and rollback strategies.
|
||||
|
||||
## Package Management
|
||||
|
||||
- Use `dnf` for package installs, updates, and repo management.
|
||||
- Inspect packages with `dnf info` and `rpm -qi`.
|
||||
- Use `dnf history` for rollback and auditing.
|
||||
- Document COPR usage with caveats about support.
|
||||
|
||||
## System Configuration
|
||||
|
||||
- Use `/etc` for configuration and systemd drop-ins for overrides.
|
||||
- Favor `firewalld` for firewall configuration.
|
||||
- Use `systemctl` and `journalctl` for service management and logs.
|
||||
|
||||
## Security & Compliance
|
||||
|
||||
- Keep SELinux enforcing unless explicitly required otherwise.
|
||||
- Use `semanage`, `setsebool`, and `restorecon` for policy fixes.
|
||||
- Reference `audit2allow` sparingly and explain risks.
|
||||
|
||||
## Troubleshooting Workflow
|
||||
|
||||
1. Identify Fedora release and kernel version.
|
||||
2. Review logs (`journalctl`, `systemctl status`).
|
||||
3. Inspect package versions and recent updates.
|
||||
4. Provide step-by-step fixes with validation.
|
||||
5. Offer upgrade or rollback guidance.
|
||||
|
||||
## Deliverables
|
||||
|
||||
- Clear, reproducible commands with explanations.
|
||||
- Verification steps after each change.
|
||||
- Optional automation guidance with warnings for rawhide/unstable repos.
|
||||
433
agents/repo-architect.agent.md
Normal file
433
agents/repo-architect.agent.md
Normal file
@@ -0,0 +1,433 @@
|
||||
---
|
||||
description: 'Bootstraps and validates agentic project structures for GitHub Copilot (VS Code) and OpenCode CLI workflows. Run after `opencode /init` or VS Code Copilot initialization to scaffold proper folder hierarchies, instructions, agents, skills, and prompts.'
|
||||
model: GPT-4.1
|
||||
tools: ["changes", "codebase", "editFiles", "fetch", "new", "problems", "runCommands", "search", "terminalLastCommand"]
|
||||
---
|
||||
|
||||
# Repo Architect Agent
|
||||
|
||||
You are a **Repository Architect** specialized in scaffolding and validating agentic coding project structures. Your expertise covers GitHub Copilot (VS Code), OpenCode CLI, and modern AI-assisted development workflows.
|
||||
|
||||
## Purpose
|
||||
|
||||
Bootstrap and validate project structures that support:
|
||||
|
||||
1. **VS Code GitHub Copilot** - `.github/` directory structure
|
||||
2. **OpenCode CLI** - `.opencode/` directory structure
|
||||
3. **Hybrid setups** - Both environments coexisting with shared resources
|
||||
|
||||
## Execution Context
|
||||
|
||||
You are typically invoked immediately after:
|
||||
|
||||
- `opencode /init` command
|
||||
- VS Code "Generate Copilot Instructions" functionality
|
||||
- Manual project initialization
|
||||
- Migrating an existing project to agentic workflows
|
||||
|
||||
## Core Architecture
|
||||
|
||||
### The Three-Layer Model
|
||||
|
||||
```
|
||||
PROJECT ROOT
|
||||
│
|
||||
├── [LAYER 1: FOUNDATION - System Context]
|
||||
│ "The Immutable Laws & Project DNA"
|
||||
│ ├── .github/copilot-instructions.md ← VS Code reads this
|
||||
│ └── AGENTS.md ← OpenCode CLI reads this
|
||||
│
|
||||
├── [LAYER 2: SPECIALISTS - Agents/Personas]
|
||||
│ "The Roles & Expertise"
|
||||
│ ├── .github/agents/*.agent.md ← VS Code agent modes
|
||||
│ └── .opencode/agents/*.agent.md ← CLI bot personas
|
||||
│
|
||||
└── [LAYER 3: CAPABILITIES - Skills & Tools]
|
||||
"The Hands & Execution"
|
||||
├── .github/skills/*.md ← Complex workflows
|
||||
├── .github/prompts/*.prompt.md ← Quick reusable snippets
|
||||
└── .github/instructions/*.instructions.md ← Language/file-specific rules
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
### `/bootstrap` - Full Project Scaffolding
|
||||
|
||||
Execute complete scaffolding based on detected or specified environment:
|
||||
|
||||
1. **Detect Environment**
|
||||
- Check for existing `.github/`, `.opencode/`, etc.
|
||||
- Identify project language/framework stack
|
||||
- Determine if VS Code, OpenCode, or hybrid setup is needed
|
||||
|
||||
2. **Create Directory Structure**
|
||||
|
||||
```
|
||||
.github/
|
||||
├── copilot-instructions.md
|
||||
├── agents/
|
||||
├── instructions/
|
||||
├── prompts/
|
||||
└── skills/
|
||||
|
||||
.opencode/ # If OpenCode CLI detected/requested
|
||||
├── opencode.json
|
||||
├── agents/
|
||||
└── skills/ → symlink to .github/skills/ (preferred)
|
||||
|
||||
AGENTS.md # CLI system prompt (can symlink to copilot-instructions.md)
|
||||
```
|
||||
|
||||
3. **Generate Foundation Files**
|
||||
- Create `copilot-instructions.md` with project context
|
||||
- Create `AGENTS.md` (symlink or custom distilled version)
|
||||
- Generate starter `opencode.json` if CLI is used
|
||||
|
||||
4. **Add Starter Templates**
|
||||
- Sample agent for the primary language/framework
|
||||
- Basic instructions file for code style
|
||||
- Common prompts (test-gen, doc-gen, explain)
|
||||
|
||||
5. **Suggest Community Resources** (if awesome-copilot MCP available)
|
||||
- Search for relevant agents, instructions, and prompts
|
||||
- Recommend curated collections matching the project stack
|
||||
- Provide install links or offer direct download
|
||||
|
||||
### `/validate` - Structure Validation
|
||||
|
||||
Validate existing agentic project structure (focus on structure, not deep file inspection):
|
||||
|
||||
1. **Check Required Files & Directories**
|
||||
- [ ] `.github/copilot-instructions.md` exists and is not empty
|
||||
- [ ] `AGENTS.md` exists (if OpenCode CLI used)
|
||||
- [ ] Required directories exist (`.github/agents/`, `.github/prompts/`, etc.)
|
||||
|
||||
2. **Spot-Check File Naming**
|
||||
- [ ] Files follow lowercase-with-hyphens convention
|
||||
- [ ] Correct extensions used (`.agent.md`, `.prompt.md`, `.instructions.md`)
|
||||
|
||||
3. **Check Symlinks** (if hybrid setup)
|
||||
- [ ] Symlinks are valid and point to existing files
|
||||
|
||||
4. **Generate Report**
|
||||
```
|
||||
✅ Structure Valid | ⚠️ Warnings Found | ❌ Issues Found
|
||||
|
||||
Foundation Layer:
|
||||
✅ copilot-instructions.md (1,245 chars)
|
||||
✅ AGENTS.md (symlink → .github/copilot-instructions.md)
|
||||
|
||||
Agents Layer:
|
||||
✅ .github/agents/reviewer.md
|
||||
⚠️ .github/agents/architect.md - missing 'model' field
|
||||
|
||||
Skills Layer:
|
||||
✅ .github/skills/git-workflow.md
|
||||
❌ .github/prompts/test-gen.prompt.md - missing 'description'
|
||||
```
|
||||
|
||||
### `/migrate` - Migration from Existing Setup
|
||||
|
||||
Migrate from various existing configurations:
|
||||
|
||||
- `.cursor/` → `.github/` (Cursor rules to Copilot)
|
||||
- `.aider/` → `.github/` + `.opencode/`
|
||||
- Standalone `AGENTS.md` → Full structure
|
||||
- `.vscode/` settings → Copilot instructions
|
||||
|
||||
### `/sync` - Synchronize Environments
|
||||
|
||||
Keep VS Code and OpenCode environments in sync:
|
||||
|
||||
- Update symlinks
|
||||
- Propagate changes from shared skills
|
||||
- Validate cross-environment consistency
|
||||
|
||||
### `/suggest` - Recommend Community Resources
|
||||
|
||||
**Requires: `awesome-copilot` MCP server**
|
||||
|
||||
If the `mcp_awesome-copil_search_instructions` or `mcp_awesome-copil_load_collection` tools are available, use them to suggest relevant community resources:
|
||||
|
||||
1. **Detect Available MCP Tools**
|
||||
- Check if `mcp_awesome-copil_*` tools are accessible
|
||||
- If NOT available, skip this functionality entirely and inform user they can enable it by adding the awesome-copilot MCP server
|
||||
|
||||
2. **Search for Relevant Resources**
|
||||
- Use `mcp_awesome-copil_search_instructions` with keywords from detected stack
|
||||
- Query for: language name, framework, common patterns (e.g., "typescript", "react", "testing", "mcp")
|
||||
|
||||
3. **Suggest Collections**
|
||||
- Use `mcp_awesome-copil_list_collections` to find curated collections
|
||||
- Match collections to detected project type
|
||||
- Recommend relevant collections like:
|
||||
- `typescript-mcp-development` for TypeScript projects
|
||||
- `python-mcp-development` for Python projects
|
||||
- `csharp-dotnet-development` for .NET projects
|
||||
- `testing-automation` for test-heavy projects
|
||||
|
||||
4. **Load and Install**
|
||||
- Use `mcp_awesome-copil_load_collection` to fetch collection details
|
||||
- Provide install links for VS Code / VS Code Insiders
|
||||
- Offer to download files directly to project structure
|
||||
|
||||
**Example Workflow:**
|
||||
```
|
||||
Detected: TypeScript + React project
|
||||
|
||||
Searching awesome-copilot for relevant resources...
|
||||
|
||||
📦 Suggested Collections:
|
||||
• typescript-mcp-development - MCP server patterns for TypeScript
|
||||
• frontend-web-dev - React, Vue, Angular best practices
|
||||
• testing-automation - Playwright, Jest patterns
|
||||
|
||||
📄 Suggested Agents:
|
||||
• expert-react-frontend-engineer.agent.md
|
||||
• playwright-tester.agent.md
|
||||
|
||||
📋 Suggested Instructions:
|
||||
• typescript.instructions.md
|
||||
• reactjs.instructions.md
|
||||
|
||||
Would you like to install any of these? (Provide install links)
|
||||
```
|
||||
|
||||
**Important:** Only suggest awesome-copilot resources when the MCP tools are detected. Do not hallucinate tool availability.
|
||||
|
||||
## Scaffolding Templates
|
||||
|
||||
### copilot-instructions.md Template
|
||||
|
||||
```markdown
|
||||
# Project: {PROJECT_NAME}
|
||||
|
||||
## Overview
|
||||
{Brief project description}
|
||||
|
||||
## Tech Stack
|
||||
- Language: {LANGUAGE}
|
||||
- Framework: {FRAMEWORK}
|
||||
- Package Manager: {PACKAGE_MANAGER}
|
||||
|
||||
## Code Standards
|
||||
- Follow {STYLE_GUIDE} conventions
|
||||
- Use {FORMATTER} for formatting
|
||||
- Run {LINTER} before committing
|
||||
|
||||
## Architecture
|
||||
{High-level architecture notes}
|
||||
|
||||
## Development Workflow
|
||||
1. {Step 1}
|
||||
2. {Step 2}
|
||||
3. {Step 3}
|
||||
|
||||
## Important Patterns
|
||||
- {Pattern 1}
|
||||
- {Pattern 2}
|
||||
|
||||
## Do Not
|
||||
- {Anti-pattern 1}
|
||||
- {Anti-pattern 2}
|
||||
```
|
||||
|
||||
### Agent Template (.agent.md)
|
||||
|
||||
```markdown
|
||||
---
|
||||
description: '{DESCRIPTION}'
|
||||
model: GPT-4.1
|
||||
tools: [{RELEVANT_TOOLS}]
|
||||
---
|
||||
|
||||
# {AGENT_NAME}
|
||||
|
||||
## Role
|
||||
{Role description}
|
||||
|
||||
## Capabilities
|
||||
- {Capability 1}
|
||||
- {Capability 2}
|
||||
|
||||
## Guidelines
|
||||
{Specific guidelines for this agent}
|
||||
```
|
||||
|
||||
### Instructions Template (.instructions.md)
|
||||
|
||||
```markdown
|
||||
---
|
||||
description: '{DESCRIPTION}'
|
||||
applyTo: '{FILE_PATTERNS}'
|
||||
---
|
||||
|
||||
# {LANGUAGE/DOMAIN} Instructions
|
||||
|
||||
## Conventions
|
||||
- {Convention 1}
|
||||
- {Convention 2}
|
||||
|
||||
## Patterns
|
||||
{Preferred patterns}
|
||||
|
||||
## Anti-patterns
|
||||
{Patterns to avoid}
|
||||
```
|
||||
|
||||
### Prompt Template (.prompt.md)
|
||||
|
||||
```markdown
|
||||
---
|
||||
agent: 'agent'
|
||||
description: '{DESCRIPTION}'
|
||||
---
|
||||
|
||||
{PROMPT_CONTENT}
|
||||
```
|
||||
|
||||
### Skill Template (SKILL.md)
|
||||
|
||||
```markdown
|
||||
---
|
||||
name: '{skill-name}'
|
||||
description: '{DESCRIPTION - 10 to 1024 chars}'
|
||||
---
|
||||
|
||||
# {Skill Name}
|
||||
|
||||
## Purpose
|
||||
{What this skill enables}
|
||||
|
||||
## Instructions
|
||||
{Detailed instructions for the skill}
|
||||
|
||||
## Assets
|
||||
{Reference any bundled files}
|
||||
```
|
||||
|
||||
## Language/Framework Presets
|
||||
|
||||
When bootstrapping, offer presets based on detected stack:
|
||||
|
||||
### JavaScript/TypeScript
|
||||
- ESLint + Prettier instructions
|
||||
- Jest/Vitest testing prompt
|
||||
- Component generation skills
|
||||
|
||||
### Python
|
||||
- PEP 8 + Black/Ruff instructions
|
||||
- pytest testing prompt
|
||||
- Type hints conventions
|
||||
|
||||
### Go
|
||||
- gofmt conventions
|
||||
- Table-driven test patterns
|
||||
- Error handling guidelines
|
||||
|
||||
### Rust
|
||||
- Cargo conventions
|
||||
- Clippy guidelines
|
||||
- Memory safety patterns
|
||||
|
||||
### .NET/C#
|
||||
- dotnet conventions
|
||||
- xUnit testing patterns
|
||||
- Async/await guidelines
|
||||
|
||||
## Validation Rules
|
||||
|
||||
### Frontmatter Requirements (Reference Only)
|
||||
|
||||
These are the official requirements from awesome-copilot. The agent does NOT deep-validate every file, but uses these when generating templates:
|
||||
|
||||
| File Type | Required Fields | Recommended |
|
||||
|-----------|-----------------|-------------|
|
||||
| `.agent.md` | `description` | `model`, `tools`, `name` |
|
||||
| `.prompt.md` | `agent`, `description` | `model`, `tools`, `name` |
|
||||
| `.instructions.md` | `description`, `applyTo` | - |
|
||||
| `SKILL.md` | `name`, `description` | - |
|
||||
|
||||
**Notes:**
|
||||
- `agent` field in prompts accepts: `'agent'`, `'ask'`, or `'Plan'`
|
||||
- `applyTo` uses glob patterns like `'**/*.ts'` or `'**/*.js, **/*.ts'`
|
||||
- `name` in SKILL.md must match folder name, lowercase with hyphens
|
||||
|
||||
### Naming Conventions
|
||||
|
||||
- All files: lowercase with hyphens (`my-agent.agent.md`)
|
||||
- Skill folders: match `name` field in SKILL.md
|
||||
- No spaces in filenames
|
||||
|
||||
### Size Guidelines
|
||||
|
||||
- `copilot-instructions.md`: 500-3000 chars (keep focused)
|
||||
- `AGENTS.md`: Can be larger for CLI (cheaper context window)
|
||||
- Individual agents: 500-2000 chars
|
||||
- Skills: Up to 5000 chars with assets
|
||||
|
||||
## Execution Guidelines
|
||||
|
||||
1. **Always Detect First** - Survey the project before making changes
|
||||
2. **Prefer Non-Destructive** - Never overwrite without confirmation
|
||||
3. **Explain Tradeoffs** - When hybrid setup, explain symlink vs separate files
|
||||
4. **Validate After Changes** - Run `/validate` after `/bootstrap` or `/migrate`
|
||||
5. **Respect Existing Conventions** - Adapt templates to match project style
|
||||
6. **Check MCP Availability** - Before suggesting awesome-copilot resources, verify that `mcp_awesome-copil_*` tools are available. If not present, do NOT suggest or reference these tools. Simply skip the community resource suggestions.
|
||||
|
||||
## MCP Tool Detection
|
||||
|
||||
Before using awesome-copilot features, check for these tools:
|
||||
|
||||
```
|
||||
Available MCP tools to check:
|
||||
- mcp_awesome-copil_search_instructions
|
||||
- mcp_awesome-copil_load_instruction
|
||||
- mcp_awesome-copil_list_collections
|
||||
- mcp_awesome-copil_load_collection
|
||||
```
|
||||
|
||||
**If tools are NOT available:**
|
||||
- Skip all `/suggest` functionality
|
||||
- Do not mention awesome-copilot collections
|
||||
- Focus only on local scaffolding
|
||||
- Optionally inform user: "Enable the awesome-copilot MCP server for community resource suggestions"
|
||||
|
||||
**If tools ARE available:**
|
||||
- Proactively suggest relevant resources after `/bootstrap`
|
||||
- Include collection recommendations in validation reports
|
||||
- Offer to search for specific patterns the user might need
|
||||
|
||||
## Output Format
|
||||
|
||||
After scaffolding or validation, provide:
|
||||
|
||||
1. **Summary** - What was created/validated
|
||||
2. **Next Steps** - Recommended immediate actions
|
||||
3. **Customization Hints** - How to tailor for specific needs
|
||||
|
||||
```
|
||||
## Scaffolding Complete ✅
|
||||
|
||||
Created:
|
||||
.github/
|
||||
├── copilot-instructions.md (new)
|
||||
├── agents/
|
||||
│ └── code-reviewer.agent.md (new)
|
||||
├── instructions/
|
||||
│ └── typescript.instructions.md (new)
|
||||
└── prompts/
|
||||
└── test-gen.prompt.md (new)
|
||||
|
||||
AGENTS.md → symlink to .github/copilot-instructions.md
|
||||
|
||||
Next Steps:
|
||||
1. Review and customize copilot-instructions.md
|
||||
2. Add project-specific agents as needed
|
||||
3. Create skills for complex workflows
|
||||
|
||||
Customization:
|
||||
- Add more agents in .github/agents/
|
||||
- Create file-specific rules in .github/instructions/
|
||||
- Build reusable prompts in .github/prompts/
|
||||
```
|
||||
@@ -27,6 +27,7 @@ Custom agents for GitHub Copilot, making it easy for users and organizations to
|
||||
| [Amplitude Experiment Implementation](../agents/amplitude-experiment-implementation.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Famplitude-experiment-implementation.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Famplitude-experiment-implementation.agent.md) | This custom agent uses Amplitude's MCP tools to deploy new experiments inside of Amplitude, enabling seamless variant testing capabilities and rollout of product features. | |
|
||||
| [API Architect mode instructions](../agents/api-architect.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fapi-architect.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fapi-architect.agent.md) | Your role is that of an API architect. Help mentor the engineer by providing guidance, support, and working code. | |
|
||||
| [Apify Integration Expert](../agents/apify-integration-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fapify-integration-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fapify-integration-expert.agent.md) | Expert agent for integrating Apify Actors into codebases. Handles Actor selection, workflow design, implementation across JavaScript/TypeScript and Python, testing, and production-ready deployment. | [apify](https://github.com/mcp/com.apify/apify-mcp-server)<br />[](https://aka.ms/awesome-copilot/install/mcp-vscode?name=apify&config=%7B%22url%22%3A%22https%3A%2F%2Fmcp.apify.com%22%2C%22headers%22%3A%7B%22Authorization%22%3A%22Bearer%20%24APIFY_TOKEN%22%2C%22Content-Type%22%3A%22application%2Fjson%22%7D%7D)<br />[](https://aka.ms/awesome-copilot/install/mcp-vscodeinsiders?name=apify&config=%7B%22url%22%3A%22https%3A%2F%2Fmcp.apify.com%22%2C%22headers%22%3A%7B%22Authorization%22%3A%22Bearer%20%24APIFY_TOKEN%22%2C%22Content-Type%22%3A%22application%2Fjson%22%7D%7D)<br />[](https://aka.ms/awesome-copilot/install/mcp-visualstudio/mcp-install?%7B%22url%22%3A%22https%3A%2F%2Fmcp.apify.com%22%2C%22headers%22%3A%7B%22Authorization%22%3A%22Bearer%20%24APIFY_TOKEN%22%2C%22Content-Type%22%3A%22application%2Fjson%22%7D%7D) |
|
||||
| [Arch Linux Expert](../agents/arch-linux-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Farch-linux-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Farch-linux-expert.agent.md) | Arch Linux specialist focused on pacman, rolling-release maintenance, and Arch-centric system administration workflows. | |
|
||||
| [Arm Migration Agent](../agents/arm-migration.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Farm-migration.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Farm-migration.agent.md) | Arm Cloud Migration Assistant accelerates moving x86 workloads to Arm infrastructure. It scans the repository for architecture assumptions, portability issues, container base image and dependency incompatibilities, and recommends Arm-optimized changes. It can drive multi-arch container builds, validate performance, and guide optimization, enabling smooth cross-platform deployment directly inside GitHub. | custom-mcp<br />[](https://aka.ms/awesome-copilot/install/mcp-vscode?name=custom-mcp&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22--rm%22%2C%22-i%22%2C%22-v%22%2C%22%2524%257B%257B%2520github.workspace%2520%257D%257D%253A%252Fworkspace%22%2C%22--name%22%2C%22arm-mcp%22%2C%22armlimited%252Farm-mcp%253Alatest%22%5D%2C%22env%22%3A%7B%7D%7D)<br />[](https://aka.ms/awesome-copilot/install/mcp-vscodeinsiders?name=custom-mcp&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22--rm%22%2C%22-i%22%2C%22-v%22%2C%22%2524%257B%257B%2520github.workspace%2520%257D%257D%253A%252Fworkspace%22%2C%22--name%22%2C%22arm-mcp%22%2C%22armlimited%252Farm-mcp%253Alatest%22%5D%2C%22env%22%3A%7B%7D%7D)<br />[](https://aka.ms/awesome-copilot/install/mcp-visualstudio/mcp-install?%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22--rm%22%2C%22-i%22%2C%22-v%22%2C%22%2524%257B%257B%2520github.workspace%2520%257D%257D%253A%252Fworkspace%22%2C%22--name%22%2C%22arm-mcp%22%2C%22armlimited%252Farm-mcp%253Alatest%22%5D%2C%22env%22%3A%7B%7D%7D) |
|
||||
| [Azure AVM Bicep mode](../agents/azure-verified-modules-bicep.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fazure-verified-modules-bicep.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fazure-verified-modules-bicep.agent.md) | Create, update, or review Azure IaC in Bicep using Azure Verified Modules (AVM). | |
|
||||
| [Azure AVM Terraform mode](../agents/azure-verified-modules-terraform.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fazure-verified-modules-terraform.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fazure-verified-modules-terraform.agent.md) | Create, update, or review Azure IaC in Terraform using Azure Verified Modules (AVM). | |
|
||||
@@ -47,12 +48,14 @@ Custom agents for GitHub Copilot, making it easy for users and organizations to
|
||||
| [CAST Imaging Impact Analysis Agent](../agents/cast-imaging-impact-analysis.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fcast-imaging-impact-analysis.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fcast-imaging-impact-analysis.agent.md) | Specialized agent for comprehensive change impact assessment and risk analysis in software systems using CAST Imaging | imaging-impact-analysis<br />[](https://aka.ms/awesome-copilot/install/mcp-vscode?name=imaging-impact-analysis&config=%7B%22url%22%3A%22https%3A%2F%2Fcastimaging.io%2Fimaging%2Fmcp%2F%22%2C%22headers%22%3A%7B%22x-api-key%22%3A%22%24%7Binput%3Aimaging-key%7D%22%7D%7D)<br />[](https://aka.ms/awesome-copilot/install/mcp-vscodeinsiders?name=imaging-impact-analysis&config=%7B%22url%22%3A%22https%3A%2F%2Fcastimaging.io%2Fimaging%2Fmcp%2F%22%2C%22headers%22%3A%7B%22x-api-key%22%3A%22%24%7Binput%3Aimaging-key%7D%22%7D%7D)<br />[](https://aka.ms/awesome-copilot/install/mcp-visualstudio/mcp-install?%7B%22url%22%3A%22https%3A%2F%2Fcastimaging.io%2Fimaging%2Fmcp%2F%22%2C%22headers%22%3A%7B%22x-api-key%22%3A%22%24%7Binput%3Aimaging-key%7D%22%7D%7D) |
|
||||
| [CAST Imaging Software Discovery Agent](../agents/cast-imaging-software-discovery.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fcast-imaging-software-discovery.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fcast-imaging-software-discovery.agent.md) | Specialized agent for comprehensive software application discovery and architectural mapping through static code analysis using CAST Imaging | imaging-structural-search<br />[](https://aka.ms/awesome-copilot/install/mcp-vscode?name=imaging-structural-search&config=%7B%22url%22%3A%22https%3A%2F%2Fcastimaging.io%2Fimaging%2Fmcp%2F%22%2C%22headers%22%3A%7B%22x-api-key%22%3A%22%24%7Binput%3Aimaging-key%7D%22%7D%7D)<br />[](https://aka.ms/awesome-copilot/install/mcp-vscodeinsiders?name=imaging-structural-search&config=%7B%22url%22%3A%22https%3A%2F%2Fcastimaging.io%2Fimaging%2Fmcp%2F%22%2C%22headers%22%3A%7B%22x-api-key%22%3A%22%24%7Binput%3Aimaging-key%7D%22%7D%7D)<br />[](https://aka.ms/awesome-copilot/install/mcp-visualstudio/mcp-install?%7B%22url%22%3A%22https%3A%2F%2Fcastimaging.io%2Fimaging%2Fmcp%2F%22%2C%22headers%22%3A%7B%22x-api-key%22%3A%22%24%7Binput%3Aimaging-key%7D%22%7D%7D) |
|
||||
| [CAST Imaging Structural Quality Advisor Agent](../agents/cast-imaging-structural-quality-advisor.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fcast-imaging-structural-quality-advisor.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fcast-imaging-structural-quality-advisor.agent.md) | Specialized agent for identifying, analyzing, and providing remediation guidance for code quality issues using CAST Imaging | imaging-structural-quality<br />[](https://aka.ms/awesome-copilot/install/mcp-vscode?name=imaging-structural-quality&config=%7B%22url%22%3A%22https%3A%2F%2Fcastimaging.io%2Fimaging%2Fmcp%2F%22%2C%22headers%22%3A%7B%22x-api-key%22%3A%22%24%7Binput%3Aimaging-key%7D%22%7D%7D)<br />[](https://aka.ms/awesome-copilot/install/mcp-vscodeinsiders?name=imaging-structural-quality&config=%7B%22url%22%3A%22https%3A%2F%2Fcastimaging.io%2Fimaging%2Fmcp%2F%22%2C%22headers%22%3A%7B%22x-api-key%22%3A%22%24%7Binput%3Aimaging-key%7D%22%7D%7D)<br />[](https://aka.ms/awesome-copilot/install/mcp-visualstudio/mcp-install?%7B%22url%22%3A%22https%3A%2F%2Fcastimaging.io%2Fimaging%2Fmcp%2F%22%2C%22headers%22%3A%7B%22x-api-key%22%3A%22%24%7Binput%3Aimaging-key%7D%22%7D%7D) |
|
||||
| [CentOS Linux Expert](../agents/centos-linux-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fcentos-linux-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fcentos-linux-expert.agent.md) | CentOS (Stream/Legacy) Linux specialist focused on RHEL-compatible administration, yum/dnf workflows, and enterprise hardening. | |
|
||||
| [Clojure Interactive Programming](../agents/clojure-interactive-programming.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fclojure-interactive-programming.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fclojure-interactive-programming.agent.md) | Expert Clojure pair programmer with REPL-first methodology, architectural oversight, and interactive problem-solving. Enforces quality standards, prevents workarounds, and develops solutions incrementally through live REPL evaluation before file modifications. | |
|
||||
| [Comet Opik](../agents/comet-opik.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fcomet-opik.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fcomet-opik.agent.md) | Unified Comet Opik agent for instrumenting LLM apps, managing prompts/projects, auditing prompts, and investigating traces/metrics via the latest Opik MCP server. | opik<br />[](https://aka.ms/awesome-copilot/install/mcp-vscode?name=opik&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22opik-mcp%22%5D%2C%22env%22%3A%7B%7D%7D)<br />[](https://aka.ms/awesome-copilot/install/mcp-vscodeinsiders?name=opik&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22opik-mcp%22%5D%2C%22env%22%3A%7B%7D%7D)<br />[](https://aka.ms/awesome-copilot/install/mcp-visualstudio/mcp-install?%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22opik-mcp%22%5D%2C%22env%22%3A%7B%7D%7D) |
|
||||
| [Context7 Expert](../agents/context7.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fcontext7.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fcontext7.agent.md) | Expert in latest library versions, best practices, and correct syntax using up-to-date documentation | [context7](https://github.com/mcp/io.github.upstash/context7)<br />[](https://aka.ms/awesome-copilot/install/mcp-vscode?name=context7&config=%7B%22url%22%3A%22https%3A%2F%2Fmcp.context7.com%2Fmcp%22%2C%22headers%22%3A%7B%22CONTEXT7_API_KEY%22%3A%22%24%7B%7B%20secrets.COPILOT_MCP_CONTEXT7%20%7D%7D%22%7D%7D)<br />[](https://aka.ms/awesome-copilot/install/mcp-vscodeinsiders?name=context7&config=%7B%22url%22%3A%22https%3A%2F%2Fmcp.context7.com%2Fmcp%22%2C%22headers%22%3A%7B%22CONTEXT7_API_KEY%22%3A%22%24%7B%7B%20secrets.COPILOT_MCP_CONTEXT7%20%7D%7D%22%7D%7D)<br />[](https://aka.ms/awesome-copilot/install/mcp-visualstudio/mcp-install?%7B%22url%22%3A%22https%3A%2F%2Fmcp.context7.com%2Fmcp%22%2C%22headers%22%3A%7B%22CONTEXT7_API_KEY%22%3A%22%24%7B%7B%20secrets.COPILOT_MCP_CONTEXT7%20%7D%7D%22%7D%7D) |
|
||||
| [Create PRD Chat Mode](../agents/prd.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fprd.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fprd.agent.md) | Generate a comprehensive Product Requirements Document (PRD) in Markdown, detailing user stories, acceptance criteria, technical considerations, and metrics. Optionally create GitHub issues upon user confirmation. | |
|
||||
| [Critical thinking mode instructions](../agents/critical-thinking.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fcritical-thinking.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fcritical-thinking.agent.md) | Challenge assumptions and encourage critical thinking to ensure the best possible solution and outcomes. | |
|
||||
| [Custom Agent Foundry](../agents/custom-agent-foundry.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fcustom-agent-foundry.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fcustom-agent-foundry.agent.md) | Expert at designing and creating VS Code custom agents with optimal configurations | |
|
||||
| [Debian Linux Expert](../agents/debian-linux-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fdebian-linux-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fdebian-linux-expert.agent.md) | Debian Linux specialist focused on stable system administration, apt-based package management, and Debian policy-aligned practices. | |
|
||||
| [Debug Mode Instructions](../agents/debug.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fdebug.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fdebug.agent.md) | Debug your application to find and fix a bug | |
|
||||
| [Declarative Agents Architect](../agents/declarative-agents-architect.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fdeclarative-agents-architect.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fdeclarative-agents-architect.agent.md) | | |
|
||||
| [Demonstrate Understanding mode instructions](../agents/demonstrate-understanding.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fdemonstrate-understanding.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fdemonstrate-understanding.agent.md) | Validate user understanding of code, design patterns, and implementation details through guided questioning. | |
|
||||
@@ -68,6 +71,7 @@ Custom agents for GitHub Copilot, making it easy for users and organizations to
|
||||
| [Expert C++ software engineer mode instructions](../agents/expert-cpp-software-engineer.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fexpert-cpp-software-engineer.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fexpert-cpp-software-engineer.agent.md) | Provide expert C++ software engineering guidance using modern C++ and industry best practices. | |
|
||||
| [Expert Next.js Developer](../agents/expert-nextjs-developer.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fexpert-nextjs-developer.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fexpert-nextjs-developer.agent.md) | Expert Next.js 16 developer specializing in App Router, Server Components, Cache Components, Turbopack, and modern React patterns with TypeScript | |
|
||||
| [Expert React Frontend Engineer](../agents/expert-react-frontend-engineer.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fexpert-react-frontend-engineer.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fexpert-react-frontend-engineer.agent.md) | Expert React 19.2 frontend engineer specializing in modern hooks, Server Components, Actions, TypeScript, and performance optimization | |
|
||||
| [Fedora Linux Expert](../agents/fedora-linux-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Ffedora-linux-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Ffedora-linux-expert.agent.md) | Fedora (Red Hat family) Linux specialist focused on dnf, SELinux, and modern systemd-based workflows. | |
|
||||
| [Gilfoyle Code Review Mode](../agents/gilfoyle.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fgilfoyle.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fgilfoyle.agent.md) | Code review and analysis with the sardonic wit and technical elitism of Bertram Gilfoyle from Silicon Valley. Prepare for brutal honesty about your code. | |
|
||||
| [GitHub Actions Expert](../agents/github-actions-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fgithub-actions-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fgithub-actions-expert.agent.md) | GitHub Actions specialist focused on secure CI/CD workflows, action pinning, OIDC authentication, permissions least privilege, and supply-chain security | |
|
||||
| [Go MCP Server Development Expert](../agents/go-mcp-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fgo-mcp-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fgo-mcp-expert.agent.md) | Expert assistant for building Model Context Protocol (MCP) servers in Go using the official SDK. | |
|
||||
@@ -118,6 +122,7 @@ Custom agents for GitHub Copilot, making it easy for users and organizations to
|
||||
| [Prompt Engineer](../agents/prompt-engineer.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fprompt-engineer.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fprompt-engineer.agent.md) | A specialized chat mode for analyzing and improving prompts. Every user input is treated as a prompt to be improved. It first provides a detailed analysis of the original prompt within a <reasoning> tag, evaluating it against a systematic framework based on OpenAI's prompt engineering best practices. Following the analysis, it generates a new, improved prompt. | |
|
||||
| [Python MCP Server Expert](../agents/python-mcp-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fpython-mcp-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fpython-mcp-expert.agent.md) | Expert assistant for developing Model Context Protocol (MCP) servers in Python | |
|
||||
| [Refine Requirement or Issue Chat Mode](../agents/refine-issue.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Frefine-issue.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Frefine-issue.agent.md) | Refine the requirement or issue with Acceptance Criteria, Technical Considerations, Edge Cases, and NFRs | |
|
||||
| [Repo Architect Agent](../agents/repo-architect.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Frepo-architect.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Frepo-architect.agent.md) | Bootstraps and validates agentic project structures for GitHub Copilot (VS Code) and OpenCode CLI workflows. Run after `opencode /init` or VS Code Copilot initialization to scaffold proper folder hierarchies, instructions, agents, skills, and prompts. | |
|
||||
| [Requirements to Jira Epic & User Story Creator](../agents/atlassian-requirements-to-jira.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fatlassian-requirements-to-jira.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fatlassian-requirements-to-jira.agent.md) | Transform requirements documents into structured Jira epics and user stories with intelligent duplicate detection, change management, and user-approved creation workflow. | |
|
||||
| [Ruby MCP Expert](../agents/ruby-mcp-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fruby-mcp-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fruby-mcp-expert.agent.md) | Expert assistance for building Model Context Protocol servers in Ruby using the official MCP Ruby SDK gem with Rails integration. | |
|
||||
| [Rust Beast Mode](../agents/rust-gpt-4.1-beast-mode.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Frust-gpt-4.1-beast-mode.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Frust-gpt-4.1-beast-mode.agent.md) | Rust GPT-4.1 Coding Beast Mode for VS Code | |
|
||||
|
||||
@@ -22,6 +22,7 @@ Team and project-specific instructions to enhance GitHub Copilot's behavior for
|
||||
| [Angular Development Instructions](../instructions/angular.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fangular.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fangular.instructions.md) | Angular-specific coding standards and best practices |
|
||||
| [Ansible Conventions and Best Practices](../instructions/ansible.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fansible.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fansible.instructions.md) | Ansible conventions and best practices |
|
||||
| [Apex Development](../instructions/apex.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fapex.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fapex.instructions.md) | Guidelines and best practices for Apex development on the Salesforce Platform |
|
||||
| [Arch Linux Administration Guidelines](../instructions/arch-linux.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Farch-linux.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Farch-linux.instructions.md) | Guidance for Arch Linux administration, pacman workflows, and rolling-release best practices. |
|
||||
| [ASP.NET REST API Development](../instructions/aspnet-rest-apis.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Faspnet-rest-apis.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Faspnet-rest-apis.instructions.md) | Guidelines for building REST APIs with ASP.NET |
|
||||
| [Astro Development Instructions](../instructions/astro.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fastro.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fastro.instructions.md) | Astro development standards and best practices for content-driven websites |
|
||||
| [Azure DevOps Pipeline YAML Best Practices](../instructions/azure-devops-pipelines.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fazure-devops-pipelines.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fazure-devops-pipelines.instructions.md) | Best practices for Azure DevOps Pipeline YAML files |
|
||||
@@ -37,6 +38,7 @@ Team and project-specific instructions to enhance GitHub Copilot's behavior for
|
||||
| [C# MCP Server Development](../instructions/csharp-mcp-server.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcsharp-mcp-server.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcsharp-mcp-server.instructions.md) | Instructions for building Model Context Protocol (MCP) servers using the C# SDK |
|
||||
| [C# 코드 작성 규칙](../instructions/csharp-ko.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcsharp-ko.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcsharp-ko.instructions.md) | C# 애플리케이션 개발을 위한 코드 작성 규칙 by @jgkim999 |
|
||||
| [C# アプリケーション開発](../instructions/csharp-ja.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcsharp-ja.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcsharp-ja.instructions.md) | C# アプリケーション構築指針 by @tsubakimoto |
|
||||
| [CentOS Administration Guidelines](../instructions/centos-linux.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcentos-linux.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcentos-linux.instructions.md) | Guidance for CentOS administration, RHEL-compatible tooling, and SELinux-aware operations. |
|
||||
| [Clojure Development Instructions](../instructions/clojure.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fclojure.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fclojure.instructions.md) | Clojure-specific coding patterns, inline def usage, code block templates, and namespace handling for Clojure development. |
|
||||
| [Cmake Vcpkg](../instructions/cmake-vcpkg.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcmake-vcpkg.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcmake-vcpkg.instructions.md) | C++ project configuration and package management |
|
||||
| [Code Components](../instructions/pcf-code-components.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpcf-code-components.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpcf-code-components.instructions.md) | Understanding code components structure and implementation |
|
||||
@@ -71,11 +73,13 @@ Team and project-specific instructions to enhance GitHub Copilot's behavior for
|
||||
| [Dataverse SDK for Python — Real-World Use Cases & Templates](../instructions/dataverse-python-real-world-usecases.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdataverse-python-real-world-usecases.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdataverse-python-real-world-usecases.instructions.md) | Template specific coding standards and best practices |
|
||||
| [Dataverse SDK for Python — Testing & Debugging Strategies](../instructions/dataverse-python-testing-debugging.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdataverse-python-testing-debugging.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdataverse-python-testing-debugging.instructions.md) | Strategie specific coding standards and best practices |
|
||||
| [DDD Systems & .NET Guidelines](../instructions/dotnet-architecture-good-practices.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdotnet-architecture-good-practices.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdotnet-architecture-good-practices.instructions.md) | DDD and .NET architecture guidelines |
|
||||
| [Debian Linux Administration Guidelines](../instructions/debian-linux.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdebian-linux.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdebian-linux.instructions.md) | Guidance for Debian-based Linux administration, apt workflows, and Debian policy conventions. |
|
||||
| [Define Events (Preview)](../instructions/pcf-events.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpcf-events.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpcf-events.instructions.md) | Define and handle custom events in PCF components |
|
||||
| [Dependent Libraries (Preview)](../instructions/pcf-dependent-libraries.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpcf-dependent-libraries.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpcf-dependent-libraries.instructions.md) | Using dependent libraries in PCF components |
|
||||
| [Dev Box image definitions](../instructions/devbox-image-definition.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdevbox-image-definition.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdevbox-image-definition.instructions.md) | Authoring recommendations for creating YAML based image definition files for use with Microsoft Dev Box Team Customizations |
|
||||
| [DevOps Core Principles](../instructions/devops-core-principles.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdevops-core-principles.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdevops-core-principles.instructions.md) | Foundational instructions covering core DevOps principles, culture (CALMS), and key metrics (DORA) to guide GitHub Copilot in understanding and promoting effective software delivery. |
|
||||
| [Dotnet Wpf](../instructions/dotnet-wpf.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdotnet-wpf.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdotnet-wpf.instructions.md) | .NET WPF component and application patterns |
|
||||
| [Fedora Administration Guidelines](../instructions/fedora-linux.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Ffedora-linux.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Ffedora-linux.instructions.md) | Guidance for Fedora (Red Hat family) systems, dnf workflows, SELinux, and modern systemd practices. |
|
||||
| [Genaiscript](../instructions/genaiscript.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fgenaiscript.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fgenaiscript.instructions.md) | AI-powered script generation guidelines |
|
||||
| [Generate Modern Terraform Code For Azure](../instructions/generate-modern-terraform-code-for-azure.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fgenerate-modern-terraform-code-for-azure.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fgenerate-modern-terraform-code-for-azure.instructions.md) | Guidelines for generating modern Terraform code for Azure |
|
||||
| [Generic Code Review Instructions](../instructions/code-review-generic.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcode-review-generic.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcode-review-generic.instructions.md) | Generic code review instructions that can be customized for any project using GitHub Copilot |
|
||||
|
||||
@@ -23,6 +23,7 @@ Ready-to-use prompt templates for specific development scenarios and tasks, defi
|
||||
| [AI Model Recommendation for Copilot Chat Modes and Prompts](../prompts/model-recommendation.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fmodel-recommendation.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fmodel-recommendation.prompt.md) | Analyze chatmode or prompt files and recommend optimal AI models based on task complexity, required capabilities, and cost-efficiency |
|
||||
| [AI Prompt Engineering Safety Review & Improvement](../prompts/ai-prompt-engineering-safety-review.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fai-prompt-engineering-safety-review.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fai-prompt-engineering-safety-review.prompt.md) | Comprehensive AI prompt engineering safety review and improvement prompt. Analyzes prompts for safety, bias, security vulnerabilities, and effectiveness while providing detailed improvement recommendations with extensive frameworks, testing methodologies, and educational content. |
|
||||
| [Apple App Store Reviewer](../prompts/apple-appstore-reviewer.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fapple-appstore-reviewer.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fapple-appstore-reviewer.prompt.md) | Serves as a reviewer of the codebase with instructions on looking for Apple App Store optimizations or rejection reasons. |
|
||||
| [Arch Linux Triage](../prompts/arch-linux-triage.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Farch-linux-triage.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Farch-linux-triage.prompt.md) | Triage and resolve Arch Linux issues with pacman, systemd, and rolling-release best practices. |
|
||||
| [ASP.NET .NET Framework Containerization Prompt](../prompts/containerize-aspnet-framework.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcontainerize-aspnet-framework.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcontainerize-aspnet-framework.prompt.md) | Containerize an ASP.NET .NET Framework project by creating Dockerfile and .dockerfile files customized for the project. |
|
||||
| [ASP.NET Core Docker Containerization Prompt](../prompts/containerize-aspnetcore.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcontainerize-aspnetcore.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcontainerize-aspnetcore.prompt.md) | Containerize an ASP.NET Core project by creating Dockerfile and .dockerfile files customized for the project. |
|
||||
| [ASP.NET Minimal API with OpenAPI](../prompts/aspnet-minimal-api-openapi.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Faspnet-minimal-api-openapi.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Faspnet-minimal-api-openapi.prompt.md) | Create ASP.NET Minimal API endpoints with proper OpenAPI documentation |
|
||||
@@ -33,6 +34,7 @@ Ready-to-use prompt templates for specific development scenarios and tasks, defi
|
||||
| [Boost Prompt](../prompts/boost-prompt.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fboost-prompt.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fboost-prompt.prompt.md) | Interactive prompt refinement workflow: interrogates scope, deliverables, constraints; copies final markdown to clipboard; never writes code. Requires the Joyride extension. |
|
||||
| [C# Async Programming Best Practices](../prompts/csharp-async.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcsharp-async.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcsharp-async.prompt.md) | Get best practices for C# async programming |
|
||||
| [C# Documentation Best Practices](../prompts/csharp-docs.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcsharp-docs.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcsharp-docs.prompt.md) | Ensure that C# types are documented with XML comments and follow best practices for documentation. |
|
||||
| [CentOS Linux Triage](../prompts/centos-linux-triage.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcentos-linux-triage.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcentos-linux-triage.prompt.md) | Triage and resolve CentOS issues using RHEL-compatible tooling, SELinux-aware practices, and firewalld. |
|
||||
| [Code Exemplars Blueprint Generator](../prompts/code-exemplars-blueprint-generator.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcode-exemplars-blueprint-generator.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcode-exemplars-blueprint-generator.prompt.md) | Technology-agnostic prompt generator that creates customizable AI prompts for scanning codebases and identifying high-quality code exemplars. Supports multiple programming languages (.NET, Java, JavaScript, TypeScript, React, Angular, Python) with configurable analysis depth, categorization methods, and documentation formats to establish coding standards and maintain consistency across development teams. |
|
||||
| [Comment Code Generate A Tutorial](../prompts/comment-code-generate-a-tutorial.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcomment-code-generate-a-tutorial.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcomment-code-generate-a-tutorial.prompt.md) | Transform this Python script into a polished, beginner-friendly project by refactoring the code, adding clear instructional comments, and generating a complete markdown tutorial. |
|
||||
| [Comprehensive Project Architecture Blueprint Generator](../prompts/architecture-blueprint-generator.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Farchitecture-blueprint-generator.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Farchitecture-blueprint-generator.prompt.md) | Comprehensive project architecture blueprint generator that analyzes codebases to create detailed architectural documentation. Automatically detects technology stacks and architectural patterns, generates visual diagrams, documents implementation patterns, and provides extensible blueprints for maintaining architectural consistency and guiding new development. |
|
||||
@@ -61,6 +63,7 @@ Ready-to-use prompt templates for specific development scenarios and tasks, defi
|
||||
| [Dataverse Python Use Case Solution Builder](../prompts/dataverse-python-usecase-builder.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdataverse-python-usecase-builder.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdataverse-python-usecase-builder.prompt.md) | Generate complete solutions for specific Dataverse SDK use cases with architecture recommendations |
|
||||
| [Dataverse Python Advanced Patterns](../prompts/dataverse-python-advanced-patterns.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdataverse-python-advanced-patterns.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdataverse-python-advanced-patterns.prompt.md) | Generate production code for Dataverse SDK using advanced patterns, error handling, and optimization techniques. |
|
||||
| [Dataverse Python Quickstart Generator](../prompts/dataverse-python-quickstart.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdataverse-python-quickstart.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdataverse-python-quickstart.prompt.md) | Generate Python SDK setup + CRUD + bulk + paging snippets using official patterns. |
|
||||
| [Debian Linux Triage](../prompts/debian-linux-triage.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdebian-linux-triage.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdebian-linux-triage.prompt.md) | Triage and resolve Debian Linux issues with apt, systemd, and AppArmor-aware guidance. |
|
||||
| [DevOps Rollout Plan Generator](../prompts/devops-rollout-plan.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdevops-rollout-plan.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdevops-rollout-plan.prompt.md) | Generate comprehensive rollout plans with preflight checks, step-by-step deployment, verification signals, rollback procedures, and communication plans for infrastructure and application changes |
|
||||
| [Diátaxis Documentation Expert](../prompts/documentation-writer.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdocumentation-writer.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdocumentation-writer.prompt.md) | Diátaxis Documentation Expert. An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework. |
|
||||
| [EditorConfig Expert](../prompts/editorconfig.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Feditorconfig.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Feditorconfig.prompt.md) | Generates a comprehensive and best-practice-oriented .editorconfig file based on project analysis and user preferences. |
|
||||
@@ -69,6 +72,7 @@ Ready-to-use prompt templates for specific development scenarios and tasks, defi
|
||||
| [Epic Product Requirements Document (PRD) Prompt](../prompts/breakdown-epic-pm.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-epic-pm.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-epic-pm.prompt.md) | Prompt for creating an Epic Product Requirements Document (PRD) for a new epic. This PRD will be used as input for generating a technical architecture specification. |
|
||||
| [Feature Implementation Plan Prompt](../prompts/breakdown-feature-implementation.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-feature-implementation.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-feature-implementation.prompt.md) | Prompt for creating detailed feature implementation plans, following Epoch monorepo structure. |
|
||||
| [Feature PRD Prompt](../prompts/breakdown-feature-prd.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-feature-prd.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-feature-prd.prompt.md) | Prompt for creating Product Requirements Documents (PRDs) for new features, based on an Epic. |
|
||||
| [Fedora Linux Triage](../prompts/fedora-linux-triage.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ffedora-linux-triage.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ffedora-linux-triage.prompt.md) | Triage and resolve Fedora issues with dnf, systemd, and SELinux-aware guidance. |
|
||||
| [Finalize Agent Prompt](../prompts/finalize-agent-prompt.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ffinalize-agent-prompt.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ffinalize-agent-prompt.prompt.md) | Finalize prompt file using the role of an AI agent to polish the prompt for the end user. |
|
||||
| [Generate Application from OpenAPI Spec](../prompts/openapi-to-application-code.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fopenapi-to-application-code.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fopenapi-to-application-code.prompt.md) | Generate a complete, production-ready application from an OpenAPI specification |
|
||||
| [Generate C# MCP Server](../prompts/csharp-mcp-server-generator.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcsharp-mcp-server-generator.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcsharp-mcp-server-generator.prompt.md) | Generate a complete MCP server project in C# with tools, prompts, and proper configuration |
|
||||
|
||||
@@ -37,6 +37,7 @@ Skills differ from other primitives by supporting bundled assets (scripts, code
|
||||
| [image-manipulation-image-magick](../skills/image-manipulation-image-magick/SKILL.md) | Process and manipulate images using ImageMagick. Supports resizing, format conversion, batch processing, and retrieving image metadata. Use when working with images, creating thumbnails, resizing wallpapers, or performing batch image operations. | None |
|
||||
| [legacy-circuit-mockups](../skills/legacy-circuit-mockups/SKILL.md) | Generate breadboard circuit mockups and visual diagrams using HTML5 Canvas drawing techniques. Use when asked to create circuit layouts, visualize electronic component placements, draw breadboard diagrams, mockup 6502 builds, generate retro computer schematics, or design vintage electronics projects. Supports 555 timers, W65C02S microprocessors, 28C256 EEPROMs, W65C22 VIA chips, 7400-series logic gates, LEDs, resistors, capacitors, switches, buttons, crystals, and wires. | `references/28256-eeprom.md`<br />`references/555.md`<br />`references/6502.md`<br />`references/6522.md`<br />`references/6C62256.md`<br />`references/7400-series.md`<br />`references/assembly-compiler.md`<br />`references/assembly-language.md`<br />`references/basic-electronic-components.md`<br />`references/breadboard.md`<br />`references/common-breadboard-components.md`<br />`references/connecting-electronic-components.md`<br />`references/emulator-28256-eeprom.md`<br />`references/emulator-6502.md`<br />`references/emulator-6522.md`<br />`references/emulator-6C62256.md`<br />`references/emulator-lcd.md`<br />`references/lcd.md`<br />`references/minipro.md`<br />`references/t48eeprom-programmer.md` |
|
||||
| [make-skill-template](../skills/make-skill-template/SKILL.md) | Create new Agent Skills for GitHub Copilot from prompts or by duplicating this template. Use when asked to "create a skill", "make a new skill", "scaffold a skill", or when building specialized AI capabilities with bundled resources. Generates SKILL.md files with proper frontmatter, directory structure, and optional scripts/references/assets folders. | None |
|
||||
| [markdown-to-html](../skills/markdown-to-html/SKILL.md) | Convert Markdown files to HTML similar to `marked.js`, `pandoc`, `gomarkdown/markdown`, or similar tools; or writing custom script to convert markdown to html and/or working on web template systems like `jekyll/jekyll`, `gohugoio/hugo`, or similar web templating systems that utilize markdown documents, converting them to html. Use when asked to "convert markdown to html", "transform md to html", "render markdown", "generate html from markdown", or when working with .md files and/or web a templating system that converts markdown to HTML output. Supports CLI and Node.js workflows with GFM, CommonMark, and standard Markdown flavors. | `references/basic-markdown-to-html.md`<br />`references/basic-markdown.md`<br />`references/code-blocks-to-html.md`<br />`references/code-blocks.md`<br />`references/collapsed-sections-to-html.md`<br />`references/collapsed-sections.md`<br />`references/gomarkdown.md`<br />`references/hugo.md`<br />`references/jekyll.md`<br />`references/marked.md`<br />`references/pandoc.md`<br />`references/tables-to-html.md`<br />`references/tables.md`<br />`references/writing-mathematical-expressions-to-html.md`<br />`references/writing-mathematical-expressions.md` |
|
||||
| [mcp-cli](../skills/mcp-cli/SKILL.md) | Interface for MCP (Model Context Protocol) servers via CLI. Use when you need to interact with external tools, APIs, or data sources through MCP servers, list available MCP servers/tools, or call MCP tools from command line. | None |
|
||||
| [microsoft-code-reference](../skills/microsoft-code-reference/SKILL.md) | Look up Microsoft API references, find working code samples, and verify SDK code is correct. Use when working with Azure SDKs, .NET libraries, or Microsoft APIs—to find the right method, check parameters, get working examples, or troubleshoot errors. Catches hallucinated methods, wrong signatures, and deprecated patterns by querying official docs. | None |
|
||||
| [microsoft-docs](../skills/microsoft-docs/SKILL.md) | Query official Microsoft documentation to understand concepts, find tutorials, and learn how services work. Use for Azure, .NET, Microsoft 365, Windows, Power Platform, and all Microsoft technologies. Get accurate, current information from learn.microsoft.com and other official Microsoft websites—architecture overviews, quickstarts, configuration guides, limits, and best practices. | None |
|
||||
@@ -46,8 +47,10 @@ Skills differ from other primitives by supporting bundled assets (scripts, code
|
||||
| [refactor](../skills/refactor/SKILL.md) | Surgical code refactoring to improve maintainability without changing behavior. Covers extracting functions, renaming variables, breaking down god functions, improving type safety, eliminating code smells, and applying design patterns. Less drastic than repo-rebuilder; use for gradual improvements. | None |
|
||||
| [scoutqa-test](../skills/scoutqa-test/SKILL.md) | This skill should be used when the user asks to "test this website", "run exploratory testing", "check for accessibility issues", "verify the login flow works", "find bugs on this page", or requests automated QA testing. Triggers on web application testing scenarios including smoke tests, accessibility audits, e-commerce flows, and user flow validation using ScoutQA CLI. IMPORTANT: Use this skill proactively after implementing web application features to verify they work correctly - don't wait for the user to ask for testing. | None |
|
||||
| [snowflake-semanticview](../skills/snowflake-semanticview/SKILL.md) | Create, alter, and validate Snowflake semantic views using Snowflake CLI (snow). Use when asked to build or troubleshoot semantic views/semantic layer definitions with CREATE/ALTER SEMANTIC VIEW, to validate semantic-view DDL against Snowflake via CLI, or to guide Snowflake CLI installation and connection setup. | None |
|
||||
| [terraform-azurerm-set-diff-analyzer](../skills/terraform-azurerm-set-diff-analyzer/SKILL.md) | Analyze Terraform plan JSON output for AzureRM Provider to distinguish between false-positive diffs (order-only changes in Set-type attributes) and actual resource changes. Use when reviewing terraform plan output for Azure resources like Application Gateway, Load Balancer, Firewall, Front Door, NSG, and other resources with Set-type attributes that cause spurious diffs due to internal ordering changes. | `references/azurerm_set_attributes.json`<br />`references/azurerm_set_attributes.md`<br />`scripts/.gitignore`<br />`scripts/README.md`<br />`scripts/analyze_plan.py` |
|
||||
| [vscode-ext-commands](../skills/vscode-ext-commands/SKILL.md) | Guidelines for contributing commands in VS Code extensions. Indicates naming convention, visibility, localization and other relevant attributes, following VS Code extension development guidelines, libraries and good practices | None |
|
||||
| [vscode-ext-localization](../skills/vscode-ext-localization/SKILL.md) | Guidelines for proper localization of VS Code extensions, following VS Code extension development guidelines, libraries and good practices | None |
|
||||
| [web-design-reviewer](../skills/web-design-reviewer/SKILL.md) | This skill enables visual inspection of websites running locally or remotely to identify and fix design issues. Triggers on requests like "review website design", "check the UI", "fix the layout", "find design problems". Detects issues with responsive design, accessibility, visual consistency, and layout breakage, then performs fixes at the source code level. | `references/framework-fixes.md`<br />`references/visual-checklist.md` |
|
||||
| [webapp-testing](../skills/webapp-testing/SKILL.md) | Toolkit for interacting with and testing local web applications using Playwright. Supports verifying frontend functionality, debugging UI behavior, capturing browser screenshots, and viewing browser logs. | `test-helper.js` |
|
||||
| [winapp-cli](../skills/winapp-cli/SKILL.md) | Windows App Development CLI (winapp) for building, packaging, and deploying Windows applications. Use when asked to initialize Windows app projects, create MSIX packages, generate AppxManifest.xml, manage development certificates, add package identity for debugging, sign packages, or access Windows SDK build tools. Supports .NET, C++, Electron, Rust, Tauri, and cross-platform frameworks targeting Windows. | None |
|
||||
| [workiq-copilot](../skills/workiq-copilot/SKILL.md) | Guides the Copilot CLI on how to use the WorkIQ CLI/MCP server to query Microsoft 365 Copilot data (emails, meetings, docs, Teams, people) for live context, summaries, and recommendations. | None |
|
||||
|
||||
38
instructions/arch-linux.instructions.md
Normal file
38
instructions/arch-linux.instructions.md
Normal file
@@ -0,0 +1,38 @@
|
||||
---
|
||||
description: 'Guidance for Arch Linux administration, pacman workflows, and rolling-release best practices.'
|
||||
applyTo: '**'
|
||||
---
|
||||
|
||||
# Arch Linux Administration Guidelines
|
||||
|
||||
Use these instructions when writing guidance, scripts, or documentation for Arch Linux systems.
|
||||
|
||||
## Platform Alignment
|
||||
|
||||
- Emphasize the rolling-release model and the need for full upgrades.
|
||||
- Confirm current kernel and recent package changes when troubleshooting.
|
||||
- Prefer official repositories and the Arch Wiki for authoritative guidance.
|
||||
|
||||
## Package Management
|
||||
|
||||
- Use `pacman -Syu` for full system upgrades; avoid partial upgrades.
|
||||
- Inspect packages with `pacman -Qi`, `pacman -Ql`, and `pacman -Ss`.
|
||||
- Mention AUR helpers only with explicit cautions and PKGBUILD review reminders.
|
||||
|
||||
## Configuration & Services
|
||||
|
||||
- Keep configuration under `/etc` and avoid editing files in `/usr`.
|
||||
- Use systemd drop-ins in `/etc/systemd/system/<unit>.d/`.
|
||||
- Use `systemctl` and `journalctl` for service control and logs.
|
||||
|
||||
## Security
|
||||
|
||||
- Note reboot requirements after kernel or core library upgrades.
|
||||
- Recommend least-privilege `sudo` usage and minimal packages.
|
||||
- Call out firewall tooling expectations (nftables/ufw) explicitly.
|
||||
|
||||
## Deliverables
|
||||
|
||||
- Provide commands in copy-paste-ready blocks.
|
||||
- Include validation steps after changes.
|
||||
- Offer rollback or cleanup steps for risky operations.
|
||||
@@ -6,7 +6,7 @@ applyTo: '**/*.cs, **/*.json'
|
||||
# ASP.NET REST API Development
|
||||
|
||||
## Instruction
|
||||
- Guide users through building their first REST API using ASP.NET Core 9.
|
||||
- Guide users through building their first REST API using ASP.NET Core 10.
|
||||
- Explain both traditional Web API controllers and the newer Minimal API approach.
|
||||
- Provide educational context for each implementation decision to help users understand the underlying concepts.
|
||||
- Emphasize best practices for API design, testing, documentation, and deployment.
|
||||
@@ -22,11 +22,11 @@ applyTo: '**/*.cs, **/*.json'
|
||||
|
||||
## Project Setup and Structure
|
||||
|
||||
- Guide users through creating a new ASP.NET Core 9 Web API project with the appropriate templates.
|
||||
- Guide users through creating a new ASP.NET Core 10 Web API project with the appropriate templates.
|
||||
- Explain the purpose of each generated file and folder to build understanding of the project structure.
|
||||
- Demonstrate how to organize code using feature folders or domain-driven design principles.
|
||||
- Show proper separation of concerns with models, services, and data access layers.
|
||||
- Explain the Program.cs and configuration system in ASP.NET Core 9 including environment-specific settings.
|
||||
- Explain the Program.cs and configuration system in ASP.NET Core 10 including environment-specific settings.
|
||||
|
||||
## Building Controller-Based APIs
|
||||
|
||||
@@ -66,7 +66,7 @@ applyTo: '**/*.cs, **/*.json'
|
||||
- Explain the validation pipeline and how to customize validation responses.
|
||||
- Demonstrate a global exception handling strategy using middleware.
|
||||
- Show how to create consistent error responses across the API.
|
||||
- Explain problem details (RFC 7807) implementation for standardized error responses.
|
||||
- Explain problem details (RFC 9457) implementation for standardized error responses.
|
||||
|
||||
## API Versioning and Documentation
|
||||
|
||||
|
||||
39
instructions/centos-linux.instructions.md
Normal file
39
instructions/centos-linux.instructions.md
Normal file
@@ -0,0 +1,39 @@
|
||||
---
|
||||
description: 'Guidance for CentOS administration, RHEL-compatible tooling, and SELinux-aware operations.'
|
||||
applyTo: '**'
|
||||
---
|
||||
|
||||
# CentOS Administration Guidelines
|
||||
|
||||
Use these instructions when producing guidance, scripts, or documentation for CentOS environments.
|
||||
|
||||
## Platform Alignment
|
||||
|
||||
- Identify CentOS version (Stream vs. legacy) and tailor commands.
|
||||
- Prefer `dnf` for Stream/8+ and `yum` for CentOS 7.
|
||||
- Use RHEL-compatible terminology and paths.
|
||||
|
||||
## Package Management
|
||||
|
||||
- Verify repositories with GPG checks enabled.
|
||||
- Use `dnf info`/`yum info` and `dnf repoquery` for package details.
|
||||
- Use `dnf versionlock` or `yum versionlock` for stability where needed.
|
||||
- Call out EPEL dependencies and how to enable/disable them safely.
|
||||
|
||||
## Configuration & Services
|
||||
|
||||
- Place service environment files in `/etc/sysconfig/` when required.
|
||||
- Use systemd drop-ins for overrides and `systemctl` for control.
|
||||
- Prefer `firewalld` (`firewall-cmd`) unless explicitly using `iptables`/`nftables`.
|
||||
|
||||
## Security
|
||||
|
||||
- Keep SELinux in enforcing mode whenever possible.
|
||||
- Use `semanage`, `restorecon`, and `setsebool` for policy adjustments.
|
||||
- Reference `/var/log/audit/audit.log` for denials.
|
||||
|
||||
## Deliverables
|
||||
|
||||
- Provide commands in copy-paste-ready blocks.
|
||||
- Include verification steps after changes.
|
||||
- Offer rollback steps for risky operations.
|
||||
@@ -67,7 +67,7 @@ applyTo: '**/*.cs'
|
||||
- 検証パイプラインと、検証応答のカスタマイズ方法を説明します。
|
||||
- ミドルウェアを用いたグローバル例外処理戦略を示します。
|
||||
- API 全体で一貫したエラー応答を作成する方法を示します。
|
||||
- 標準化されたエラー応答のための Problem Details（RFC 7807）の実装を説明します。
|
||||
- 標準化されたエラー応答のための Problem Details（RFC 9457）の実装を説明します。
|
||||
|
||||
## API のバージョニングとドキュメント
|
||||
|
||||
|
||||
@@ -67,7 +67,7 @@ applyTo: '**/*.cs'
|
||||
- Explain the validation pipeline and how to customize validation responses.
|
||||
- Demonstrate a global exception handling strategy using middleware.
|
||||
- Show how to create consistent error responses across the API.
|
||||
- Explain problem details (RFC 7807) implementation for standardized error responses.
|
||||
- Explain problem details (RFC 9457) implementation for standardized error responses.
|
||||
|
||||
## API Versioning and Documentation
|
||||
|
||||
|
||||
40
instructions/debian-linux.instructions.md
Normal file
40
instructions/debian-linux.instructions.md
Normal file
@@ -0,0 +1,40 @@
|
||||
---
|
||||
description: 'Guidance for Debian-based Linux administration, apt workflows, and Debian policy conventions.'
|
||||
applyTo: '**'
|
||||
---
|
||||
|
||||
# Debian Linux Administration Guidelines
|
||||
|
||||
Use these instructions when writing guidance, scripts, or documentation intended for Debian-based systems.
|
||||
|
||||
## Platform Alignment
|
||||
|
||||
- Favor Debian Stable defaults and long-term support expectations.
|
||||
- Call out the Debian release (`bookworm`, `bullseye`, etc.) when relevant.
|
||||
- Prefer official Debian repositories before suggesting third-party sources.
|
||||
|
||||
## Package Management
|
||||
|
||||
- Use `apt` for interactive commands and `apt-get` for scripts.
|
||||
- Inspect packages with `apt-cache policy`, `apt show`, and `dpkg -l`.
|
||||
- Use `apt-mark` to track manual vs. auto-installed packages.
|
||||
- Document any apt pinning in `/etc/apt/preferences.d/` and explain why.
|
||||
|
||||
## Configuration & Services
|
||||
|
||||
- Store configuration under `/etc` and avoid modifying `/usr` files directly.
|
||||
- Use systemd drop-ins in `/etc/systemd/system/<unit>.d/` for overrides.
|
||||
- Prefer `systemctl` and `journalctl` for service control and logs.
|
||||
- Use `ufw` or `nftables` for firewall guidance; state which is expected.
|
||||
|
||||
## Security
|
||||
|
||||
- Account for AppArmor profiles and mention adjustments if needed.
|
||||
- Recommend least-privilege `sudo` use and minimal package installs.
|
||||
- Include verification commands after security changes.
|
||||
|
||||
## Deliverables
|
||||
|
||||
- Provide commands in copy-paste-ready blocks.
|
||||
- Include validation steps after changes.
|
||||
- Offer rollback steps for destructive actions.
|
||||
38
instructions/fedora-linux.instructions.md
Normal file
38
instructions/fedora-linux.instructions.md
Normal file
@@ -0,0 +1,38 @@
|
||||
---
|
||||
description: 'Guidance for Fedora (Red Hat family) systems, dnf workflows, SELinux, and modern systemd practices.'
|
||||
applyTo: '**'
|
||||
---
|
||||
|
||||
# Fedora Administration Guidelines
|
||||
|
||||
Use these instructions when writing guidance, scripts, or documentation for Fedora systems.
|
||||
|
||||
## Platform Alignment
|
||||
|
||||
- State the Fedora release number when relevant.
|
||||
- Prefer modern tooling (`dnf`, `systemctl`, `firewall-cmd`).
|
||||
- Note the fast release cadence and confirm compatibility for older guidance.
|
||||
|
||||
## Package Management
|
||||
|
||||
- Use `dnf` for installs and updates, and `dnf history` for rollback.
|
||||
- Inspect packages with `dnf info` and `rpm -qi`.
|
||||
- Mention COPR repositories only with clear support caveats.
|
||||
|
||||
## Configuration & Services
|
||||
|
||||
- Use systemd drop-ins in `/etc/systemd/system/<unit>.d/`.
|
||||
- Use `journalctl` for logs and `systemctl status` for service health.
|
||||
- Prefer `firewalld` unless using `nftables` explicitly.
|
||||
|
||||
## Security
|
||||
|
||||
- Keep SELinux enforcing unless the user requests permissive mode.
|
||||
- Use `semanage`, `setsebool`, and `restorecon` for policy changes.
|
||||
- Recommend targeted fixes instead of broad `audit2allow` rules.
|
||||
|
||||
## Deliverables
|
||||
|
||||
- Provide commands in copy-paste-ready blocks.
|
||||
- Include verification steps after changes.
|
||||
- Offer rollback steps for risky operations.
|
||||
33
prompts/arch-linux-triage.prompt.md
Normal file
33
prompts/arch-linux-triage.prompt.md
Normal file
@@ -0,0 +1,33 @@
|
||||
---
|
||||
agent: 'agent'
|
||||
description: 'Triage and resolve Arch Linux issues with pacman, systemd, and rolling-release best practices.'
|
||||
model: 'gpt-4.1'
|
||||
tools: ['search', 'runCommands', 'terminalCommand', 'edit/editFiles']
|
||||
---
|
||||
|
||||
# Arch Linux Triage
|
||||
|
||||
You are an Arch Linux expert. Diagnose and resolve the user’s issue using Arch-appropriate tooling and practices.
|
||||
|
||||
## Inputs
|
||||
|
||||
- `${input:ArchSnapshot}` (optional)
|
||||
- `${input:ProblemSummary}`
|
||||
- `${input:Constraints}` (optional)
|
||||
|
||||
## Instructions
|
||||
|
||||
1. Confirm recent updates and environment assumptions.
|
||||
2. Provide a step-by-step triage plan using `systemctl`, `journalctl`, and `pacman`.
|
||||
3. Offer remediation steps with copy-paste-ready commands.
|
||||
4. Include verification commands after each major change.
|
||||
5. Address kernel update or reboot considerations where relevant.
|
||||
6. Provide rollback or cleanup steps.
|
||||
|
||||
## Output Format
|
||||
|
||||
- **Summary**
|
||||
- **Triage Steps** (numbered)
|
||||
- **Remediation Commands** (code blocks)
|
||||
- **Validation** (code blocks)
|
||||
- **Rollback/Cleanup**
|
||||
33
prompts/centos-linux-triage.prompt.md
Normal file
33
prompts/centos-linux-triage.prompt.md
Normal file
@@ -0,0 +1,33 @@
|
||||
---
|
||||
agent: 'agent'
|
||||
description: 'Triage and resolve CentOS issues using RHEL-compatible tooling, SELinux-aware practices, and firewalld.'
|
||||
model: 'gpt-4.1'
|
||||
tools: ['search', 'runCommands', 'terminalCommand', 'edit/editFiles']
|
||||
---
|
||||
|
||||
# CentOS Linux Triage
|
||||
|
||||
You are a CentOS Linux expert. Diagnose and resolve the user’s issue with RHEL-compatible commands and practices.
|
||||
|
||||
## Inputs
|
||||
|
||||
- `${input:CentOSVersion}` (optional)
|
||||
- `${input:ProblemSummary}`
|
||||
- `${input:Constraints}` (optional)
|
||||
|
||||
## Instructions
|
||||
|
||||
1. Confirm CentOS release (Stream vs. legacy) and environment assumptions.
|
||||
2. Provide triage steps using `systemctl`, `journalctl`, `dnf`/`yum`, and logs.
|
||||
3. Offer remediation steps with copy-paste-ready commands.
|
||||
4. Include verification commands after each major change.
|
||||
5. Address SELinux and `firewalld` considerations where relevant.
|
||||
6. Provide rollback or cleanup steps.
|
||||
|
||||
## Output Format
|
||||
|
||||
- **Summary**
|
||||
- **Triage Steps** (numbered)
|
||||
- **Remediation Commands** (code blocks)
|
||||
- **Validation** (code blocks)
|
||||
- **Rollback/Cleanup**
|
||||
33
prompts/debian-linux-triage.prompt.md
Normal file
33
prompts/debian-linux-triage.prompt.md
Normal file
@@ -0,0 +1,33 @@
|
||||
---
|
||||
agent: 'agent'
|
||||
description: 'Triage and resolve Debian Linux issues with apt, systemd, and AppArmor-aware guidance.'
|
||||
model: 'gpt-4.1'
|
||||
tools: ['search', 'runCommands', 'terminalCommand', 'edit/editFiles']
|
||||
---
|
||||
|
||||
# Debian Linux Triage
|
||||
|
||||
You are a Debian Linux expert. Diagnose and resolve the user’s issue with Debian-appropriate tooling and practices.
|
||||
|
||||
## Inputs
|
||||
|
||||
- `${input:DebianRelease}` (optional)
|
||||
- `${input:ProblemSummary}`
|
||||
- `${input:Constraints}` (optional)
|
||||
|
||||
## Instructions
|
||||
|
||||
1. Confirm Debian release and environment assumptions; ask concise follow-ups if required.
|
||||
2. Provide a step-by-step triage plan using `systemctl`, `journalctl`, `apt`, and `dpkg`.
|
||||
3. Offer remediation steps with copy-paste-ready commands.
|
||||
4. Include verification commands after each major change.
|
||||
5. Note AppArmor or firewall considerations if relevant.
|
||||
6. Provide rollback or cleanup steps.
|
||||
|
||||
## Output Format
|
||||
|
||||
- **Summary**
|
||||
- **Triage Steps** (numbered)
|
||||
- **Remediation Commands** (code blocks)
|
||||
- **Validation** (code blocks)
|
||||
- **Rollback/Cleanup**
|
||||
33
prompts/fedora-linux-triage.prompt.md
Normal file
33
prompts/fedora-linux-triage.prompt.md
Normal file
@@ -0,0 +1,33 @@
|
||||
---
|
||||
agent: 'agent'
|
||||
description: 'Triage and resolve Fedora issues with dnf, systemd, and SELinux-aware guidance.'
|
||||
model: 'gpt-4.1'
|
||||
tools: ['search', 'runCommands', 'terminalCommand', 'edit/editFiles']
|
||||
---
|
||||
|
||||
# Fedora Linux Triage
|
||||
|
||||
You are a Fedora Linux expert. Diagnose and resolve the user’s issue using Fedora-appropriate tooling and practices.
|
||||
|
||||
## Inputs
|
||||
|
||||
- `${input:FedoraRelease}` (optional)
|
||||
- `${input:ProblemSummary}`
|
||||
- `${input:Constraints}` (optional)
|
||||
|
||||
## Instructions
|
||||
|
||||
1. Confirm Fedora release and environment assumptions.
|
||||
2. Provide a step-by-step triage plan using `systemctl`, `journalctl`, and `dnf`.
|
||||
3. Offer remediation steps with copy-paste-ready commands.
|
||||
4. Include verification commands after each major change.
|
||||
5. Address SELinux and `firewalld` considerations where relevant.
|
||||
6. Provide rollback or cleanup steps.
|
||||
|
||||
## Output Format
|
||||
|
||||
- **Summary**
|
||||
- **Triage Steps** (numbered)
|
||||
- **Remediation Commands** (code blocks)
|
||||
- **Validation** (code blocks)
|
||||
- **Rollback/Cleanup**
|
||||
916
skills/markdown-to-html/SKILL.md
Normal file
916
skills/markdown-to-html/SKILL.md
Normal file
@@ -0,0 +1,916 @@
|
||||
---
|
||||
name: markdown-to-html
|
||||
description: 'Convert Markdown files to HTML similar to `marked.js`, `pandoc`, `gomarkdown/markdown`, or similar tools; or writing custom script to convert markdown to html and/or working on web template systems like `jekyll/jekyll`, `gohugoio/hugo`, or similar web templating systems that utilize markdown documents, converting them to html. Use when asked to "convert markdown to html", "transform md to html", "render markdown", "generate html from markdown", or when working with .md files and/or web a templating system that converts markdown to HTML output. Supports CLI and Node.js workflows with GFM, CommonMark, and standard Markdown flavors.'
|
||||
---
|
||||
|
||||
# Markdown to HTML Conversion
|
||||
|
||||
Expert skill for converting Markdown documents to HTML using the marked.js library, or writing data conversion scripts; in this case scripts similar to [markedJS/marked](https://github.com/markedjs/marked) repository. For custom scripts knowledge is not confined to `marked.js`, but data conversion methods are utilized from tools like [pandoc](https://github.com/jgm/pandoc) and [gomarkdown/markdown](https://github.com/gomarkdown/markdown) for data conversion; [jekyll/jekyll](https://github.com/jekyll/jekyll) and [gohugoio/hugo](https://github.com/gohugoio/hugo) for templating systems.
|
||||
|
||||
The conversion script or tool should handle single files, batch conversions, and advanced configurations.
|
||||
|
||||
## When to Use This Skill
|
||||
|
||||
- User asks to "convert markdown to html" or "transform md files"
|
||||
- User wants to "render markdown" as HTML output
|
||||
- User needs to generate HTML documentation from .md files
|
||||
- User is building static sites from Markdown content
|
||||
- User is building template system that converts markdown to html
|
||||
- User is working on a tool, widget, or custom template for an existing templating system
|
||||
- User wants to preview Markdown as rendered HTML
|
||||
|
||||
## Converting Markdown to HTML
|
||||
|
||||
### Essential Basic Conversions
|
||||
|
||||
For more see [basic-markdown-to-html.md](references/basic-markdown-to-html.md)
|
||||
|
||||
```text
|
||||
```markdown
|
||||
# Level 1
|
||||
## Level 2
|
||||
|
||||
One sentence with a [link](https://example.com), and a HTML snippet like `<p>paragraph tag</p>`.
|
||||
|
||||
- `ul` list item 1
|
||||
- `ul` list item 2
|
||||
|
||||
1. `ol` list item 1
|
||||
2. `ol` list item 1
|
||||
|
||||
| Table Item | Description |
|
||||
| One | One is the spelling of the number `1`. |
|
||||
| Two | Two is the spelling of the number `2`. |
|
||||
|
||||
```js
|
||||
var one = 1;
|
||||
var two = 2;
|
||||
|
||||
function simpleMath(x, y) {
|
||||
return x + y;
|
||||
}
|
||||
console.log(simpleMath(one, two));
|
||||
```
|
||||
```
|
||||
|
||||
```html
|
||||
<h1>Level 1</h1>
|
||||
<h2>Level 2</h2>
|
||||
|
||||
<p>One sentence with a <a href="https://example.com">link</a>, and a HTML snippet like <code><p>paragraph tag</p></code>.</p>
|
||||
|
||||
<ul>
|
||||
<li>`ul` list item 1</li>
|
||||
<li>`ul` list item 2</li>
|
||||
</ul>
|
||||
|
||||
<ol>
|
||||
<li>`ol` list item 1</li>
|
||||
<li>`ol` list item 2</li>
|
||||
</ol>
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Table Item</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>One</td>
|
||||
<td>One is the spelling of the number `1`.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Two</td>
|
||||
<td>Two is the spelling of the number `2`.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<pre>
|
||||
<code>var one = 1;
|
||||
var two = 2;
|
||||
|
||||
function simpleMath(x, y) {
|
||||
return x + y;
|
||||
}
|
||||
console.log(simpleMath(one, two));</code>
|
||||
</pre>
|
||||
```
|
||||
```
|
||||
|
||||
### Code Block Conversions
|
||||
|
||||
For more see [code-blocks-to-html.md](references/code-blocks-to-html.md)
|
||||
|
||||
```text
|
||||
|
||||
```markdown
|
||||
your code here
|
||||
```
|
||||
|
||||
```html
|
||||
<pre><code class="language-md">
|
||||
your code here
|
||||
</code></pre>
|
||||
```
|
||||
|
||||
```js
|
||||
console.log("Hello world");
|
||||
```
|
||||
|
||||
```html
|
||||
<pre><code class="language-js">
|
||||
console.log("Hello world");
|
||||
</code></pre>
|
||||
```
|
||||
|
||||
```markdown
|
||||
```
|
||||
|
||||
```
|
||||
visible backticks
|
||||
```
|
||||
|
||||
```
|
||||
```
|
||||
|
||||
```html
|
||||
<pre><code>
|
||||
```
|
||||
|
||||
visible backticks
|
||||
|
||||
```
|
||||
</code></pre>
|
||||
```
|
||||
```
|
||||
|
||||
### Collapsed Section Conversions
|
||||
|
||||
For more see [collapsed-sections-to-html.md](references/collapsed-sections-to-html.md)
|
||||
|
||||
```text
|
||||
```markdown
|
||||
<details>
|
||||
<summary>More info</summary>
|
||||
|
||||
### Header inside
|
||||
|
||||
- Lists
|
||||
- **Formatting**
|
||||
- Code blocks
|
||||
|
||||
```js
|
||||
console.log("Hello");
|
||||
```
|
||||
|
||||
</details>
|
||||
```
|
||||
|
||||
```html
|
||||
<details>
|
||||
<summary>More info</summary>
|
||||
|
||||
<h3>Header inside</h3>
|
||||
|
||||
<ul>
|
||||
<li>Lists</li>
|
||||
<li><strong>Formatting</strong></li>
|
||||
<li>Code blocks</li>
|
||||
</ul>
|
||||
|
||||
<pre>
|
||||
<code class="language-js">console.log("Hello");</code>
|
||||
</pre>
|
||||
|
||||
</details>
|
||||
```
|
||||
```
|
||||
|
||||
### Mathematical Expression Conversions
|
||||
|
||||
For more see [writing-mathematical-expressions-to-html.md](references/writing-mathematical-expressions-to-html.md)
|
||||
|
||||
```text
|
||||
```markdown
|
||||
This sentence uses `$` delimiters to show math inline: $\sqrt{3x-1}+(1+x)^2$
|
||||
```
|
||||
|
||||
```html
|
||||
<p>This sentence uses <code>$</code> delimiters to show math inline:
|
||||
<math-renderer><math xmlns="http://www.w3.org/1998/Math/MathML">
|
||||
<msqrt><mn>3</mn><mi>x</mi><mo>−</mo><mn>1</mn></msqrt>
|
||||
<mo>+</mo><mo>(</mo><mn>1</mn><mo>+</mo><mi>x</mi>
|
||||
<msup><mo>)</mo><mn>2</mn></msup>
|
||||
</math>
|
||||
</math-renderer>
|
||||
</p>
|
||||
```
|
||||
|
||||
```markdown
|
||||
**The Cauchy-Schwarz Inequality**\
|
||||
$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
|
||||
```
|
||||
|
||||
```html
|
||||
<p><strong>The Cauchy-Schwarz Inequality</strong><br>
|
||||
<math-renderer>
|
||||
<math xmlns="http://www.w3.org/1998/Math/MathML">
|
||||
<msup>
|
||||
<mrow><mo>(</mo>
|
||||
<munderover><mo data-mjx-texclass="OP">∑</mo>
|
||||
<mrow><mi>k</mi><mo>=</mo><mn>1</mn></mrow><mi>n</mi>
|
||||
</munderover>
|
||||
<msub><mi>a</mi><mi>k</mi></msub>
|
||||
<msub><mi>b</mi><mi>k</mi></msub>
|
||||
<mo>)</mo>
|
||||
</mrow>
|
||||
<mn>2</mn>
|
||||
</msup>
|
||||
<mo>≤</mo>
|
||||
<mrow><mo>(</mo>
|
||||
<munderover><mo>∑</mo>
|
||||
<mrow><mi>k</mi><mo>=</mo><mn>1</mn></mrow>
|
||||
<mi>n</mi>
|
||||
</munderover>
|
||||
<msubsup><mi>a</mi><mi>k</mi><mn>2</mn></msubsup>
|
||||
<mo>)</mo>
|
||||
</mrow>
|
||||
<mrow><mo>(</mo>
|
||||
<munderover><mo>∑</mo>
|
||||
<mrow><mi>k</mi><mo>=</mo><mn>1</mn></mrow>
|
||||
<mi>n</mi>
|
||||
</munderover>
|
||||
<msubsup><mi>b</mi><mi>k</mi><mn>2</mn></msubsup>
|
||||
<mo>)</mo>
|
||||
</mrow>
|
||||
</math>
|
||||
</math-renderer></p>
|
||||
```
|
||||
```
|
||||
|
||||
### Table Conversions
|
||||
|
||||
For more see [tables-to-html.md](references/tables-to-html.md)
|
||||
|
||||
```text
|
||||
```markdown
|
||||
| First Header | Second Header |
|
||||
| ------------- | ------------- |
|
||||
| Content Cell | Content Cell |
|
||||
| Content Cell | Content Cell |
|
||||
```
|
||||
|
||||
```html
|
||||
<table>
|
||||
<thead><tr><th>First Header</th><th>Second Header</th></tr></thead>
|
||||
<tbody>
|
||||
<tr><td>Content Cell</td><td>Content Cell</td></tr>
|
||||
<tr><td>Content Cell</td><td>Content Cell</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
```
|
||||
|
||||
```markdown
|
||||
| Left-aligned | Center-aligned | Right-aligned |
|
||||
| :--- | :---: | ---: |
|
||||
| git status | git status | git status |
|
||||
| git diff | git diff | git diff |
|
||||
```
|
||||
|
||||
```html
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Left-aligned</th>
|
||||
<th align="center">Center-aligned</th>
|
||||
<th align="right">Right-aligned</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left">git status</td>
|
||||
<td align="center">git status</td>
|
||||
<td align="right">git status</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left">git diff</td>
|
||||
<td align="center">git diff</td>
|
||||
<td align="right">git diff</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
```
|
||||
```
|
||||
|
||||
## Working with [`markedJS/marked`](references/marked.md)
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Node.js installed (for CLI or programmatic usage)
|
||||
- Install marked globally for CLI: `npm install -g marked`
|
||||
- Or install locally: `npm install marked`
|
||||
|
||||
### Quick Conversion Methods
|
||||
|
||||
See [marked.md](references/marked.md) **Quick Conversion Methods**
|
||||
|
||||
### Step-by-Step Workflows
|
||||
|
||||
See [marked.md](references/marked.md) **Step-by-Step Workflows**
|
||||
|
||||
### CLI Configuration
|
||||
|
||||
### Using Config Files
|
||||
|
||||
Create `~/.marked.json` for persistent options:
|
||||
|
||||
```json
|
||||
{
|
||||
"gfm": true,
|
||||
"breaks": true
|
||||
}
|
||||
```
|
||||
|
||||
Or use a custom config:
|
||||
|
||||
```bash
|
||||
marked -i input.md -o output.html -c config.json
|
||||
```
|
||||
|
||||
### CLI Options Reference
|
||||
|
||||
| Option | Description |
|
||||
|--------|-------------|
|
||||
| `-i, --input <file>` | Input Markdown file |
|
||||
| `-o, --output <file>` | Output HTML file |
|
||||
| `-s, --string <string>` | Parse string instead of file |
|
||||
| `-c, --config <file>` | Use custom config file |
|
||||
| `--gfm` | Enable GitHub Flavored Markdown |
|
||||
| `--breaks` | Convert newlines to `<br>` |
|
||||
| `--help` | Show all options |
|
||||
|
||||
### Security Warning
|
||||
|
||||
⚠️ **Marked does NOT sanitize output HTML.** For untrusted input, use a sanitizer:
|
||||
|
||||
```javascript
|
||||
import { marked } from 'marked';
|
||||
import DOMPurify from 'dompurify';
|
||||
|
||||
const unsafeHtml = marked.parse(untrustedMarkdown);
|
||||
const safeHtml = DOMPurify.sanitize(unsafeHtml);
|
||||
```
|
||||
|
||||
Recommended sanitizers:
|
||||
|
||||
- [DOMPurify](https://github.com/cure53/DOMPurify) (recommended)
|
||||
- [sanitize-html](https://github.com/apostrophecms/sanitize-html)
|
||||
- [js-xss](https://github.com/leizongmin/js-xss)
|
||||
|
||||
### Supported Markdown Flavors
|
||||
|
||||
| Flavor | Support |
|
||||
|--------|---------|
|
||||
| Original Markdown | 100% |
|
||||
| CommonMark 0.31 | 98% |
|
||||
| GitHub Flavored Markdown | 97% |
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
| Issue | Solution |
|
||||
|-------|----------|
|
||||
| Special characters at file start | Strip zero-width chars: `content.replace(/^[\u200B\u200C\u200D\uFEFF]/,"")` |
|
||||
| Code blocks not highlighting | Add a syntax highlighter like highlight.js |
|
||||
| Tables not rendering | Ensure `gfm: true` option is set |
|
||||
| Line breaks ignored | Set `breaks: true` in options |
|
||||
| XSS vulnerability concerns | Use DOMPurify to sanitize output |
|
||||
|
||||
## Working with [`pandoc`](references/pandoc.md)
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Pandoc installed (download from <https://pandoc.org/installing.html>)
|
||||
- For PDF output: LaTeX installation (MacTeX on macOS, MiKTeX on Windows, texlive on Linux)
|
||||
- Terminal/command prompt access
|
||||
|
||||
### Quick Conversion Methods
|
||||
|
||||
#### Method 1: CLI Basic Conversion
|
||||
|
||||
```bash
|
||||
# Convert markdown to HTML
|
||||
pandoc input.md -o output.html
|
||||
|
||||
# Convert with standalone document (includes header/footer)
|
||||
pandoc input.md -s -o output.html
|
||||
|
||||
# Explicit format specification
|
||||
pandoc input.md -f markdown -t html -s -o output.html
|
||||
```
|
||||
|
||||
#### Method 2: Filter Mode (Interactive)
|
||||
|
||||
```bash
|
||||
# Start pandoc as a filter
|
||||
pandoc
|
||||
|
||||
# Type markdown, then Ctrl-D (Linux/macOS) or Ctrl-Z+Enter (Windows)
|
||||
Hello *pandoc*!
|
||||
# Output: <p>Hello <em>pandoc</em>!</p>
|
||||
```
|
||||
|
||||
#### Method 3: Format Conversion
|
||||
|
||||
```bash
|
||||
# HTML to Markdown
|
||||
pandoc -f html -t markdown input.html -o output.md
|
||||
|
||||
# Markdown to LaTeX
|
||||
pandoc input.md -s -o output.tex
|
||||
|
||||
# Markdown to PDF (requires LaTeX)
|
||||
pandoc input.md -s -o output.pdf
|
||||
|
||||
# Markdown to Word
|
||||
pandoc input.md -s -o output.docx
|
||||
```
|
||||
|
||||
### CLI Configuration
|
||||
|
||||
| Option | Description |
|
||||
|--------|-------------|
|
||||
| `-f, --from <format>` | Input format (markdown, html, latex, etc.) |
|
||||
| `-t, --to <format>` | Output format (html, latex, pdf, docx, etc.) |
|
||||
| `-s, --standalone` | Produce standalone document with header/footer |
|
||||
| `-o, --output <file>` | Output file (inferred from extension) |
|
||||
| `--mathml` | Convert TeX math to MathML |
|
||||
| `--metadata title="Title"` | Set document metadata |
|
||||
| `--toc` | Include table of contents |
|
||||
| `--template <file>` | Use custom template |
|
||||
| `--help` | Show all options |
|
||||
|
||||
### Security Warning
|
||||
|
||||
⚠️ **Pandoc processes input faithfully.** When converting untrusted markdown:
|
||||
|
||||
- Use `--sandbox` mode to disable external file access
|
||||
- Validate input before processing
|
||||
- Sanitize HTML output if displayed in browsers
|
||||
|
||||
```bash
|
||||
# Run in sandbox mode for untrusted input
|
||||
pandoc --sandbox input.md -o output.html
|
||||
```
|
||||
|
||||
### Supported Markdown Flavors
|
||||
|
||||
| Flavor | Support |
|
||||
|--------|---------|
|
||||
| Pandoc Markdown | 100% (native) |
|
||||
| CommonMark | Full (use `-f commonmark`) |
|
||||
| GitHub Flavored Markdown | Full (use `-f gfm`) |
|
||||
| MultiMarkdown | Partial |
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
| Issue | Solution |
|
||||
|-------|----------|
|
||||
| PDF generation fails | Install LaTeX (MacTeX, MiKTeX, or texlive) |
|
||||
| Encoding issues on Windows | Run `chcp 65001` before using pandoc |
|
||||
| Missing standalone headers | Add `-s` flag for complete documents |
|
||||
| Math not rendering | Use `--mathml` or `--mathjax` option |
|
||||
| Tables not rendering | Ensure proper table syntax with pipes and dashes |
|
||||
|
||||
## Working with [`gomarkdown/markdown`](references/gomarkdown.md)
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Go 1.18 or higher installed
|
||||
- Install the library: `go get github.com/gomarkdown/markdown`
|
||||
- For CLI tool: `go install github.com/gomarkdown/mdtohtml@latest`
|
||||
|
||||
### Quick Conversion Methods
|
||||
|
||||
#### Method 1: Simple Conversion (Go)
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"github.com/gomarkdown/markdown"
|
||||
)
|
||||
|
||||
func main() {
|
||||
md := []byte("# Hello World\n\nThis is **bold** text.")
|
||||
html := markdown.ToHTML(md, nil, nil)
|
||||
fmt.Println(string(html))
|
||||
}
|
||||
```
|
||||
|
||||
#### Method 2: CLI Tool
|
||||
|
||||
```bash
|
||||
# Install mdtohtml
|
||||
go install github.com/gomarkdown/mdtohtml@latest
|
||||
|
||||
# Convert file
|
||||
mdtohtml input.md output.html
|
||||
|
||||
# Convert file (output to stdout)
|
||||
mdtohtml input.md
|
||||
```
|
||||
|
||||
#### Method 3: Custom Parser and Renderer
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"github.com/gomarkdown/markdown"
|
||||
"github.com/gomarkdown/markdown/html"
|
||||
"github.com/gomarkdown/markdown/parser"
|
||||
)
|
||||
|
||||
func mdToHTML(md []byte) []byte {
|
||||
// Create parser with extensions
|
||||
extensions := parser.CommonExtensions | parser.AutoHeadingIDs | parser.NoEmptyLineBeforeBlock
|
||||
p := parser.NewWithExtensions(extensions)
|
||||
doc := p.Parse(md)
|
||||
|
||||
// Create HTML renderer with extensions
|
||||
htmlFlags := html.CommonFlags | html.HrefTargetBlank
|
||||
opts := html.RendererOptions{Flags: htmlFlags}
|
||||
renderer := html.NewRenderer(opts)
|
||||
|
||||
return markdown.Render(doc, renderer)
|
||||
}
|
||||
```
|
||||
|
||||
### CLI Configuration
|
||||
|
||||
The `mdtohtml` CLI tool has minimal options:
|
||||
|
||||
```bash
|
||||
mdtohtml input-file [output-file]
|
||||
```
|
||||
|
||||
For advanced configuration, use the Go library programmatically with parser and renderer options:
|
||||
|
||||
| Parser Extension | Description |
|
||||
|------------------|-------------|
|
||||
| `parser.CommonExtensions` | Tables, fenced code, autolinks, strikethrough, etc. |
|
||||
| `parser.AutoHeadingIDs` | Generate IDs for headings |
|
||||
| `parser.NoEmptyLineBeforeBlock` | No blank line needed before blocks |
|
||||
| `parser.MathJax` | MathJax support for LaTeX math |
|
||||
|
||||
| HTML Flag | Description |
|
||||
|-----------|-------------|
|
||||
| `html.CommonFlags` | Common HTML output flags |
|
||||
| `html.HrefTargetBlank` | Add `target="_blank"` to links |
|
||||
| `html.CompletePage` | Generate complete HTML page |
|
||||
| `html.UseXHTML` | Generate XHTML output |
|
||||
|
||||
### Security Warning
|
||||
|
||||
⚠️ **gomarkdown does NOT sanitize output HTML.** For untrusted input, use Bluemonday:
|
||||
|
||||
```go
|
||||
import (
|
||||
"github.com/microcosm-cc/bluemonday"
|
||||
"github.com/gomarkdown/markdown"
|
||||
)
|
||||
|
||||
maybeUnsafeHTML := markdown.ToHTML(md, nil, nil)
|
||||
html := bluemonday.UGCPolicy().SanitizeBytes(maybeUnsafeHTML)
|
||||
```
|
||||
|
||||
Recommended sanitizer: [Bluemonday](https://github.com/microcosm-cc/bluemonday)
|
||||
|
||||
### Supported Markdown Flavors
|
||||
|
||||
| Flavor | Support |
|
||||
|--------|---------|
|
||||
| Original Markdown | 100% |
|
||||
| CommonMark | High (with extensions) |
|
||||
| GitHub Flavored Markdown | High (tables, fenced code, strikethrough) |
|
||||
| MathJax/LaTeX Math | Supported via extension |
|
||||
| Mmark | Supported |
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
| Issue | Solution |
|
||||
|-------|----------|
|
||||
| Windows/Mac newlines not parsed | Use `parser.NormalizeNewlines(input)` |
|
||||
| Tables not rendering | Enable `parser.Tables` extension |
|
||||
| Code blocks without highlighting | Integrate with syntax highlighter like Chroma |
|
||||
| Math not rendering | Enable `parser.MathJax` extension |
|
||||
| XSS vulnerabilities | Use Bluemonday to sanitize output |
|
||||
|
||||
## Working with [`jekyll`](references/jekyll.md)
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Ruby version 2.7.0 or higher
|
||||
- RubyGems
|
||||
- GCC and Make (for native extensions)
|
||||
- Install Jekyll and Bundler: `gem install jekyll bundler`
|
||||
|
||||
### Quick Conversion Methods
|
||||
|
||||
#### Method 1: Create New Site
|
||||
|
||||
```bash
|
||||
# Create a new Jekyll site
|
||||
jekyll new myblog
|
||||
|
||||
# Change to site directory
|
||||
cd myblog
|
||||
|
||||
# Build and serve locally
|
||||
bundle exec jekyll serve
|
||||
|
||||
# Access at http://localhost:4000
|
||||
```
|
||||
|
||||
#### Method 2: Build Static Site
|
||||
|
||||
```bash
|
||||
# Build site to _site directory
|
||||
bundle exec jekyll build
|
||||
|
||||
# Build with production environment
|
||||
JEKYLL_ENV=production bundle exec jekyll build
|
||||
```
|
||||
|
||||
#### Method 3: Live Reload Development
|
||||
|
||||
```bash
|
||||
# Serve with live reload
|
||||
bundle exec jekyll serve --livereload
|
||||
|
||||
# Serve with drafts
|
||||
bundle exec jekyll serve --drafts
|
||||
```
|
||||
|
||||
### CLI Configuration
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `jekyll new <path>` | Create new Jekyll site |
|
||||
| `jekyll build` | Build site to `_site` directory |
|
||||
| `jekyll serve` | Build and serve locally |
|
||||
| `jekyll clean` | Remove generated files |
|
||||
| `jekyll doctor` | Check for configuration issues |
|
||||
|
||||
| Serve Options | Description |
|
||||
|---------------|-------------|
|
||||
| `--livereload` | Reload browser on changes |
|
||||
| `--drafts` | Include draft posts |
|
||||
| `--port <port>` | Set server port (default: 4000) |
|
||||
| `--host <host>` | Set server host (default: localhost) |
|
||||
| `--baseurl <url>` | Set base URL |
|
||||
|
||||
### Security Warning
|
||||
|
||||
⚠️ **Jekyll security considerations:**
|
||||
|
||||
- Avoid using `safe: false` in production
|
||||
- Use `exclude` in `_config.yml` to prevent sensitive files from being published
|
||||
- Sanitize user-generated content if accepting external input
|
||||
- Keep Jekyll and plugins updated
|
||||
|
||||
```yaml
|
||||
# _config.yml security settings
|
||||
exclude:
|
||||
- Gemfile
|
||||
- Gemfile.lock
|
||||
- node_modules
|
||||
- vendor
|
||||
```
|
||||
|
||||
### Supported Markdown Flavors
|
||||
|
||||
| Flavor | Support |
|
||||
|--------|---------|
|
||||
| Kramdown (default) | 100% |
|
||||
| CommonMark | Via plugin (jekyll-commonmark) |
|
||||
| GitHub Flavored Markdown | Via plugin (jekyll-commonmark-ghpages) |
|
||||
| RedCarpet | Via plugin (deprecated) |
|
||||
|
||||
Configure markdown processor in `_config.yml`:
|
||||
|
||||
```yaml
|
||||
markdown: kramdown
|
||||
kramdown:
|
||||
input: GFM
|
||||
syntax_highlighter: rouge
|
||||
```
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
| Issue | Solution |
|
||||
|-------|----------|
|
||||
| Ruby 3.0+ fails to serve | Run `bundle add webrick` |
|
||||
| Gem dependency errors | Run `bundle install` |
|
||||
| Slow builds | Use `--incremental` flag |
|
||||
| Liquid syntax errors | Check for unescaped `{` in content |
|
||||
| Plugin not loading | Add to `_config.yml` plugins list |
|
||||
|
||||
## Working with [`hugo`](references/hugo.md)
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Hugo installed (download from <https://gohugo.io/installation/>)
|
||||
- Git (recommended for themes and modules)
|
||||
- Go (optional, for Hugo Modules)
|
||||
|
||||
### Quick Conversion Methods
|
||||
|
||||
#### Method 1: Create New Site
|
||||
|
||||
```bash
|
||||
# Create a new Hugo site
|
||||
hugo new site mysite
|
||||
|
||||
# Change to site directory
|
||||
cd mysite
|
||||
|
||||
# Add a theme
|
||||
git init
|
||||
git submodule add https://github.com/theNewDynamic/gohugo-theme-ananke themes/ananke
|
||||
echo "theme = 'ananke'" >> hugo.toml
|
||||
|
||||
# Create content
|
||||
hugo new content posts/my-first-post.md
|
||||
|
||||
# Start development server
|
||||
hugo server -D
|
||||
```
|
||||
|
||||
#### Method 2: Build Static Site
|
||||
|
||||
```bash
|
||||
# Build site to public directory
|
||||
hugo
|
||||
|
||||
# Build with minification
|
||||
hugo --minify
|
||||
|
||||
# Build for specific environment
|
||||
hugo --environment production
|
||||
```
|
||||
|
||||
#### Method 3: Development Server
|
||||
|
||||
```bash
|
||||
# Start server with drafts
|
||||
hugo server -D
|
||||
|
||||
# Start with live reload and bind to all interfaces
|
||||
hugo server --bind 0.0.0.0 --baseURL http://localhost:1313/
|
||||
|
||||
# Start with specific port
|
||||
hugo server --port 8080
|
||||
```
|
||||
|
||||
### CLI Configuration
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `hugo new site <name>` | Create new Hugo site |
|
||||
| `hugo new content <path>` | Create new content file |
|
||||
| `hugo` | Build site to `public` directory |
|
||||
| `hugo server` | Start development server |
|
||||
| `hugo mod init` | Initialize Hugo Modules |
|
||||
|
||||
| Build Options | Description |
|
||||
|---------------|-------------|
|
||||
| `-D, --buildDrafts` | Include draft content |
|
||||
| `-E, --buildExpired` | Include expired content |
|
||||
| `-F, --buildFuture` | Include future-dated content |
|
||||
| `--minify` | Minify output |
|
||||
| `--gc` | Run garbage collection after build |
|
||||
| `-d, --destination <path>` | Output directory |
|
||||
|
||||
| Server Options | Description |
|
||||
|----------------|-------------|
|
||||
| `--bind <ip>` | Interface to bind to |
|
||||
| `-p, --port <port>` | Port number (default: 1313) |
|
||||
| `--liveReloadPort <port>` | Live reload port |
|
||||
| `--disableLiveReload` | Disable live reload |
|
||||
| `--navigateToChanged` | Navigate to changed content |
|
||||
|
||||
### Security Warning
|
||||
|
||||
⚠️ **Hugo security considerations:**
|
||||
|
||||
- Configure security policy in `hugo.toml` for external commands
|
||||
- Use `--enableGitInfo` carefully with public repositories
|
||||
- Validate shortcode parameters for user-generated content
|
||||
|
||||
```toml
|
||||
# hugo.toml security settings
|
||||
[security]
|
||||
enableInlineShortcodes = false
|
||||
[security.exec]
|
||||
allow = ['^go$', '^npx$', '^postcss$']
|
||||
[security.funcs]
|
||||
getenv = ['^HUGO_', '^CI$']
|
||||
[security.http]
|
||||
methods = ['(?i)GET|POST']
|
||||
urls = ['.*']
|
||||
```
|
||||
|
||||
### Supported Markdown Flavors
|
||||
|
||||
| Flavor | Support |
|
||||
|--------|---------|
|
||||
| Goldmark (default) | 100% (CommonMark compliant) |
|
||||
| GitHub Flavored Markdown | Full (tables, strikethrough, autolinks) |
|
||||
| CommonMark | 100% |
|
||||
| Blackfriday (legacy) | Deprecated, not recommended |
|
||||
|
||||
Configure markdown in `hugo.toml`:
|
||||
|
||||
```toml
|
||||
[markup]
|
||||
[markup.goldmark]
|
||||
[markup.goldmark.extensions]
|
||||
definitionList = true
|
||||
footnote = true
|
||||
linkify = true
|
||||
strikethrough = true
|
||||
table = true
|
||||
taskList = true
|
||||
[markup.goldmark.renderer]
|
||||
unsafe = false # Set true to allow raw HTML
|
||||
```
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
| Issue | Solution |
|
||||
|-------|----------|
|
||||
| "Page not found" on paths | Check `baseURL` in config |
|
||||
| Theme not loading | Verify theme in `themes/` or Hugo Modules |
|
||||
| Slow builds | Use `--templateMetrics` to identify bottlenecks |
|
||||
| Raw HTML not rendering | Set `unsafe = true` in goldmark config |
|
||||
| Images not loading | Check `static/` folder structure |
|
||||
| Module errors | Run `hugo mod tidy` |
|
||||
|
||||
## References
|
||||
|
||||
### Writing and Styling Markdown
|
||||
|
||||
- [basic-markdown.md](references/basic-markdown.md)
|
||||
- [code-blocks.md](references/code-blocks.md)
|
||||
- [collapsed-sections.md](references/collapsed-sections.md)
|
||||
- [tables.md](references/tables.md)
|
||||
- [writing-mathematical-expressions.md](references/writing-mathematical-expressions.md)
|
||||
- Markdown Guide: <https://www.markdownguide.org/basic-syntax/>
|
||||
- Styling Markdown: <https://github.com/sindresorhus/github-markdown-css>
|
||||
|
||||
### [`markedJS/marked`](references/marked.md)
|
||||
|
||||
- Official documentation: <https://marked.js.org/>
|
||||
- Advanced options: <https://marked.js.org/using_advanced>
|
||||
- Extensibility: <https://marked.js.org/using_pro>
|
||||
- GitHub repository: <https://github.com/markedjs/marked>
|
||||
|
||||
### [`pandoc`](references/pandoc.md)
|
||||
|
||||
- Getting started: <https://pandoc.org/getting-started.html>
|
||||
- Official documentation: <https://pandoc.org/MANUAL.html>
|
||||
- Extensibility: <https://pandoc.org/extras.html>
|
||||
- GitHub repository: <https://github.com/jgm/pandoc>
|
||||
|
||||
### [`gomarkdown/markdown`](references/gomarkdown.md)
|
||||
|
||||
- Official documentation: <https://pkg.go.dev/github.com/gomarkdown/markdown>
|
||||
- Advanced configuration: <https://pkg.go.dev/github.com/gomarkdown/markdown@v0.0.0-20250810172220-2e2c11897d1a/html>
|
||||
- Markdown processing: <https://blog.kowalczyk.info/article/cxn3/advanced-markdown-processing-in-go.html>
|
||||
- GitHub repository: <https://github.com/gomarkdown/markdown>
|
||||
|
||||
### [`jekyll`](references/jekyll.md)
|
||||
|
||||
- Official documentation: <https://jekyllrb.com/docs/>
|
||||
- Configuration options: <https://jekyllrb.com/docs/configuration/options/>
|
||||
- Plugins: <https://jekyllrb.com/docs/plugins/>
|
||||
- [Installation](https://jekyllrb.com/docs/plugins/installation/)
|
||||
- [Generators](https://jekyllrb.com/docs/plugins/generators/)
|
||||
- [Converters](https://jekyllrb.com/docs/plugins/converters/)
|
||||
- [Commands](https://jekyllrb.com/docs/plugins/commands/)
|
||||
- [Tags](https://jekyllrb.com/docs/plugins/tags/)
|
||||
- [Filters](https://jekyllrb.com/docs/plugins/filters/)
|
||||
- [Hooks](https://jekyllrb.com/docs/plugins/hooks/)
|
||||
- GitHub repository: <https://github.com/jekyll/jekyll>
|
||||
|
||||
### [`hugo`](references/hugo.md)
|
||||
|
||||
- Official documentation: <https://gohugo.io/documentation/>
|
||||
- All Settings: <https://gohugo.io/configuration/all/>
|
||||
- Editor Plugins: <https://gohugo.io/tools/editors/>
|
||||
- GitHub repository: <https://github.com/gohugoio/hugo>
|
||||
420
skills/markdown-to-html/references/basic-markdown-to-html.md
Normal file
420
skills/markdown-to-html/references/basic-markdown-to-html.md
Normal file
@@ -0,0 +1,420 @@
|
||||
# Basic Markdown to HTML
|
||||
|
||||
## Headings
|
||||
|
||||
### Markdown
|
||||
|
||||
```md
|
||||
# Basic writing and formatting syntax
|
||||
```
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<h1>Basic writing and formatting syntax</h1>
|
||||
```
|
||||
|
||||
```md
|
||||
## Headings
|
||||
```
|
||||
|
||||
```html
|
||||
<h2>Headings</h2>
|
||||
```
|
||||
|
||||
```md
|
||||
### A third-level heading
|
||||
```
|
||||
|
||||
```html
|
||||
<h3>A third-level heading</h3>
|
||||
```
|
||||
|
||||
### Markdown
|
||||
|
||||
```md
|
||||
Heading 2
|
||||
---
|
||||
```
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<h2>Heading 2</h2>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Paragraphs
|
||||
|
||||
### Markdown
|
||||
|
||||
```md
|
||||
Create sophisticated formatting for your prose and code on GitHub with simple syntax.
|
||||
```
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<p>Create sophisticated formatting for your prose and code on GitHub with simple syntax.</p>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Inline Formatting
|
||||
|
||||
### Bold
|
||||
|
||||
```md
|
||||
**This is bold text**
|
||||
```
|
||||
|
||||
```html
|
||||
<strong>This is bold text</strong>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Italic
|
||||
|
||||
```md
|
||||
_This text is italicized_
|
||||
```
|
||||
|
||||
```html
|
||||
<em>This text is italicized</em>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Bold + Italic
|
||||
|
||||
```md
|
||||
***All this text is important***
|
||||
```
|
||||
|
||||
```html
|
||||
<strong><em>All this text is important</em></strong>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Strikethrough (GFM)
|
||||
|
||||
```md
|
||||
~~This was mistaken text~~
|
||||
```
|
||||
|
||||
```html
|
||||
<del>This was mistaken text</del>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Subscript / Superscript (raw HTML passthrough)
|
||||
|
||||
```md
|
||||
This is a <sub>subscript</sub> text
|
||||
```
|
||||
|
||||
```html
|
||||
<p>This is a <sub>subscript</sub> text</p>
|
||||
```
|
||||
|
||||
```md
|
||||
This is a <sup>superscript</sup> text
|
||||
```
|
||||
|
||||
```html
|
||||
<p>This is a <sup>superscript</sup> text</p>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Blockquotes
|
||||
|
||||
### Markdown
|
||||
|
||||
```md
|
||||
> Text that is a quote
|
||||
```
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<blockquote>
|
||||
<p>Text that is a quote</p>
|
||||
</blockquote>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### GitHub Alert (NOTE)
|
||||
|
||||
```md
|
||||
> [!NOTE]
|
||||
> Useful information.
|
||||
```
|
||||
|
||||
```html
|
||||
<blockquote class="markdown-alert markdown-alert-note">
|
||||
<p><strong>Note</strong></p>
|
||||
<p>Useful information.</p>
|
||||
</blockquote>
|
||||
```
|
||||
|
||||
> ⚠️ The `markdown-alert-*` classes are GitHub-specific, not standard Markdown.
|
||||
|
||||
---
|
||||
|
||||
## Inline Code
|
||||
|
||||
```md
|
||||
Use `git status` to list files.
|
||||
```
|
||||
|
||||
```html
|
||||
<p>Use <code>git status</code> to list files.</p>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Code Blocks
|
||||
|
||||
### Markdown
|
||||
|
||||
````md
|
||||
```markdown
|
||||
git status
|
||||
git add
|
||||
```
|
||||
````
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<pre><code class="language-markdown">
|
||||
git status
|
||||
git add
|
||||
</code></pre>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Tables
|
||||
|
||||
### Markdown
|
||||
|
||||
```md
|
||||
| Style | Syntax |
|
||||
|------|--------|
|
||||
| Bold | ** ** |
|
||||
```
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Style</th>
|
||||
<th>Syntax</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Bold</td>
|
||||
<td><strong> </strong></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Links
|
||||
|
||||
### Markdown
|
||||
|
||||
```md
|
||||
[GitHub Pages](https://pages.github.com/)
|
||||
```
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<a href="https://pages.github.com/">GitHub Pages</a>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Images
|
||||
|
||||
### Markdown
|
||||
|
||||
```md
|
||||
|
||||
```
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<img src="image.png" alt="Alt text">
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Lists
|
||||
|
||||
### Unordered List
|
||||
|
||||
```md
|
||||
- George Washington
|
||||
- John Adams
|
||||
```
|
||||
|
||||
```html
|
||||
<ul>
|
||||
<li>George Washington</li>
|
||||
<li>John Adams</li>
|
||||
</ul>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Ordered List
|
||||
|
||||
```md
|
||||
1. James Madison
|
||||
2. James Monroe
|
||||
```
|
||||
|
||||
```html
|
||||
<ol>
|
||||
<li>James Madison</li>
|
||||
<li>James Monroe</li>
|
||||
</ol>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Nested Lists
|
||||
|
||||
```md
|
||||
1. First item
|
||||
- Nested item
|
||||
```
|
||||
|
||||
```html
|
||||
<ol>
|
||||
<li>
|
||||
First item
|
||||
<ul>
|
||||
<li>Nested item</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ol>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Task Lists (GitHub Flavored Markdown)
|
||||
|
||||
```md
|
||||
- [x] Done
|
||||
- [ ] Pending
|
||||
```
|
||||
|
||||
```html
|
||||
<ul>
|
||||
<li>
|
||||
<input type="checkbox" checked disabled> Done
|
||||
</li>
|
||||
<li>
|
||||
<input type="checkbox" disabled> Pending
|
||||
</li>
|
||||
</ul>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Mentions
|
||||
|
||||
```md
|
||||
@github/support
|
||||
```
|
||||
|
||||
```html
|
||||
<a href="https://github.com/github/support" class="user-mention">@github/support</a>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Footnotes
|
||||
|
||||
### Markdown
|
||||
|
||||
```md
|
||||
Here is a footnote[^1].
|
||||
|
||||
[^1]: My reference.
|
||||
```
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<p>
|
||||
Here is a footnote
|
||||
<sup id="fnref-1">
|
||||
<a href="#fn-1">1</a>
|
||||
</sup>.
|
||||
</p>
|
||||
|
||||
<section class="footnotes">
|
||||
<ol>
|
||||
<li id="fn-1">
|
||||
<p>My reference.</p>
|
||||
</li>
|
||||
</ol>
|
||||
</section>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## HTML Comments (Hidden Content)
|
||||
|
||||
```md
|
||||
<!-- This content will not appear -->
|
||||
```
|
||||
|
||||
```html
|
||||
<!-- This content will not appear -->
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Escaped Markdown Characters
|
||||
|
||||
```md
|
||||
\*not italic\*
|
||||
```
|
||||
|
||||
```html
|
||||
<p>*not italic*</p>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Emoji
|
||||
|
||||
```md
|
||||
:+1:
|
||||
```
|
||||
|
||||
```html
|
||||
<img class="emoji" alt="👍" src="...">
|
||||
```
|
||||
|
||||
(GitHub replaces emoji with `<img>` tags.)
|
||||
|
||||
---
|
||||
496
skills/markdown-to-html/references/basic-markdown.md
Normal file
496
skills/markdown-to-html/references/basic-markdown.md
Normal file
@@ -0,0 +1,496 @@
|
||||
# Basic writing and formatting syntax
|
||||
|
||||
Create sophisticated formatting for your prose and code on GitHub with simple syntax.
|
||||
|
||||
## Headings
|
||||
|
||||
To create a heading, add one to six <kbd>#</kbd> symbols before your heading text. The number of <kbd>#</kbd> you use will determine the hierarchy level and typeface size of the heading.
|
||||
|
||||
```markdown
|
||||
# A first-level heading
|
||||
## A second-level heading
|
||||
### A third-level heading
|
||||
```
|
||||
|
||||
|
||||
|
||||
When you use two or more headings, GitHub automatically generates a table of contents that you can access by clicking the "Outline" menu icon <svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-list-unordered" aria-label="Table of Contents" role="img"><path d="M5.75 2.5h8.5a.75.75 0 0 1 0 1.5h-8.5a.75.75 0 0 1 0-1.5Zm0 5h8.5a.75.75 0 0 1 0 1.5h-8.5a.75.75 0 0 1 0-1.5Zm0 5h8.5a.75.75 0 0 1 0 1.5h-8.5a.75.75 0 0 1 0-1.5ZM2 14a1 1 0 1 1 0-2 1 1 0 0 1 0 2Zm1-6a1 1 0 1 1-2 0 1 1 0 0 1 2 0ZM2 4a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z"></path></svg> within the file header. Each heading title is listed in the table of contents and you can click a title to navigate to the selected section.
|
||||
|
||||
|
||||
|
||||
## Styling text
|
||||
|
||||
You can indicate emphasis with bold, italic, strikethrough, subscript, or superscript text in comment fields and `.md` files.
|
||||
|
||||
| Style | Syntax | Keyboard shortcut | Example | Output | |
|
||||
| ---------------------- | ------------------- | ------------------------------------------------------------------------------------- | ---------------------------------------- | -------------------------------------- | ------------------------------------------------- |
|
||||
| Bold | `** **` or `__ __` | <kbd>Command</kbd>+<kbd>B</kbd> (Mac) or <kbd>Ctrl</kbd>+<kbd>B</kbd> (Windows/Linux) | `**This is bold text**` | **This is bold text** | |
|
||||
| Italic | `* *` or `_ _` | <kbd>Command</kbd>+<kbd>I</kbd> (Mac) or <kbd>Ctrl</kbd>+<kbd>I</kbd> (Windows/Linux) | `_This text is italicized_` | *This text is italicized* | |
|
||||
| Strikethrough | `~~ ~~` or `~ ~` | None | `~~This was mistaken text~~` | ~~This was mistaken text~~ | |
|
||||
| Bold and nested italic | `** **` and `_ _` | None | `**This text is _extremely_ important**` | **This text is *extremely* important** | |
|
||||
| All bold and italic | `*** ***` | None | `***All this text is important***` | ***All this text is important*** | <!-- markdownlint-disable-line emphasis-style --> |
|
||||
| Subscript | `<sub> </sub>` | None | `This is a <sub>subscript</sub> text` | This is a <sub>subscript</sub> text | |
|
||||
| Superscript | `<sup> </sup>` | None | `This is a <sup>superscript</sup> text` | This is a <sup>superscript</sup> text | |
|
||||
| Underline | `<ins> </ins>` | None | `This is an <ins>underlined</ins> text` | This is an <ins>underlined</ins> text | |
|
||||
|
||||
## Quoting text
|
||||
|
||||
You can quote text with a <kbd>></kbd>.
|
||||
|
||||
```markdown
|
||||
Text that is not a quote
|
||||
|
||||
> Text that is a quote
|
||||
```
|
||||
|
||||
Quoted text is indented with a vertical line on the left and displayed using gray type.
|
||||
|
||||
|
||||
|
||||
> \[!NOTE]
|
||||
> When viewing a conversation, you can automatically quote text in a comment by highlighting the text, then typing <kbd>R</kbd>. You can quote an entire comment by clicking <svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-kebab-horizontal" aria-label="The horizontal kebab icon" role="img"><path d="M8 9a1.5 1.5 0 1 0 0-3 1.5 1.5 0 0 0 0 3ZM1.5 9a1.5 1.5 0 1 0 0-3 1.5 1.5 0 0 0 0 3Zm13 0a1.5 1.5 0 1 0 0-3 1.5 1.5 0 0 0 0 3Z"></path></svg>, then **Quote reply**. For more information about keyboard shortcuts, see [Keyboard shortcuts](https://docs.github.com/en/get-started/accessibility/keyboard-shortcuts).
|
||||
|
||||
## Quoting code
|
||||
|
||||
You can call out code or a command within a sentence with single backticks. The text within the backticks will not be formatted. You can also press the <kbd>Command</kbd>+<kbd>E</kbd> (Mac) or <kbd>Ctrl</kbd>+<kbd>E</kbd> (Windows/Linux) keyboard shortcut to insert the backticks for a code block within a line of Markdown.
|
||||
|
||||
```markdown
|
||||
Use `git status` to list all new or modified files that haven't yet been committed.
|
||||
```
|
||||
|
||||
|
||||
|
||||
To format code or text into its own distinct block, use triple backticks.
|
||||
|
||||
````markdown
|
||||
Some basic Git commands are:
|
||||
```
|
||||
git status
|
||||
git add
|
||||
git commit
|
||||
```
|
||||
````
|
||||
|
||||
|
||||
|
||||
For more information, see [Creating and highlighting code blocks](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks).
|
||||
|
||||
If you are frequently editing code snippets and tables, you may benefit from enabling a fixed-width font in all comment fields on GitHub. For more information, see [About writing and formatting on GitHub](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github#enabling-fixed-width-fonts-in-the-editor).
|
||||
|
||||
## Supported color models
|
||||
|
||||
In issues, pull requests, and discussions, you can call out colors within a sentence by using backticks. A supported color model within backticks will display a visualization of the color.
|
||||
|
||||
```markdown
|
||||
The background color is `#ffffff` for light mode and `#000000` for dark mode.
|
||||
```
|
||||
|
||||
|
||||
|
||||
Here are the currently supported color models.
|
||||
|
||||
| Color | Syntax | Example | Output |
|
||||
| ----- | --------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| HEX | <code>\`#RRGGBB\`</code> | <code>\`#0969DA\`</code> |  |
|
||||
| RGB | <code>\`rgb(R,G,B)\`</code> | <code>\`rgb(9, 105, 218)\`</code> |  |
|
||||
| HSL | <code>\`hsl(H,S,L)\`</code> | <code>\`hsl(212, 92%, 45%)\`</code> |  |
|
||||
|
||||
> \[!NOTE]
|
||||
>
|
||||
> * A supported color model cannot have any leading or trailing spaces within the backticks.
|
||||
> * The visualization of the color is only supported in issues, pull requests, and discussions.
|
||||
|
||||
## Links
|
||||
|
||||
You can create an inline link by wrapping link text in brackets `[ ]`, and then wrapping the URL in parentheses `( )`. You can also use the keyboard shortcut <kbd>Command</kbd>+<kbd>K</kbd> to create a link. When you have text selected, you can paste a URL from your clipboard to automatically create a link from the selection.
|
||||
|
||||
You can also create a Markdown hyperlink by highlighting the text and using the keyboard shortcut <kbd>Command</kbd>+<kbd>V</kbd>. If you'd like to replace the text with the link, use the keyboard shortcut <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd>.
|
||||
|
||||
`This site was built using [GitHub Pages](https://pages.github.com/).`
|
||||
|
||||
|
||||
|
||||
> \[!NOTE]
|
||||
> GitHub automatically creates links when valid URLs are written in a comment. For more information, see [Autolinked references and URLs](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls).
|
||||
|
||||
## Section links
|
||||
|
||||
You can link directly to any section that has a heading. To view the automatically generated anchor in a rendered file, hover over the section heading to expose the <svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-link" aria-label="the link" role="img"><path d="m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z"></path></svg> icon and click the icon to display the anchor in your browser.
|
||||
|
||||
|
||||
|
||||
If you need to determine the anchor for a heading in a file you are editing, you can use the following basic rules:
|
||||
|
||||
* Letters are converted to lower-case.
|
||||
* Spaces are replaced by hyphens (`-`). Any other whitespace or punctuation characters are removed.
|
||||
* Leading and trailing whitespace are removed.
|
||||
* Markup formatting is removed, leaving only the contents (for example, `_italics_` becomes `italics`).
|
||||
* If the automatically generated anchor for a heading is identical to an earlier anchor in the same document, a unique identifier is generated by appending a hyphen and an auto-incrementing integer.
|
||||
|
||||
For more detailed information on the requirements of URI fragments, see [RFC 3986: Uniform Resource Identifier (URI): Generic Syntax, Section 3.5](https://www.rfc-editor.org/rfc/rfc3986#section-3.5).
|
||||
|
||||
The code block below demonstrates the basic rules used to generate anchors from headings in rendered content.
|
||||
|
||||
```markdown
|
||||
# Example headings
|
||||
|
||||
## Sample Section
|
||||
|
||||
## This'll be a _Helpful_ Section About the Greek Letter Θ!
|
||||
A heading containing characters not allowed in fragments, UTF-8 characters, two consecutive spaces between the first and second words, and formatting.
|
||||
|
||||
## This heading is not unique in the file
|
||||
|
||||
TEXT 1
|
||||
|
||||
## This heading is not unique in the file
|
||||
|
||||
TEXT 2
|
||||
|
||||
# Links to the example headings above
|
||||
|
||||
Link to the sample section: [Link Text](#sample-section).
|
||||
|
||||
Link to the helpful section: [Link Text](#thisll-be-a-helpful-section-about-the-greek-letter-Θ).
|
||||
|
||||
Link to the first non-unique section: [Link Text](#this-heading-is-not-unique-in-the-file).
|
||||
|
||||
Link to the second non-unique section: [Link Text](#this-heading-is-not-unique-in-the-file-1).
|
||||
```
|
||||
|
||||
> \[!NOTE]
|
||||
> If you edit a heading, or if you change the order of headings with "identical" anchors, you will also need to update any links to those headings as the anchors will change.
|
||||
|
||||
## Relative links
|
||||
|
||||
You can define relative links and image paths in your rendered files to help readers navigate to other files in your repository.
|
||||
|
||||
A relative link is a link that is relative to the current file. For example, if you have a README file in root of your repository, and you have another file in *docs/CONTRIBUTING.md*, the relative link to *CONTRIBUTING.md* in your README might look like this:
|
||||
|
||||
```text
|
||||
[Contribution guidelines for this project](docs/CONTRIBUTING.md)
|
||||
```
|
||||
|
||||
GitHub will automatically transform your relative link or image path based on whatever branch you're currently on, so that the link or path always works. The path of the link will be relative to the current file. Links starting with `/` will be relative to the repository root. You can use all relative link operands, such as `./` and `../`.
|
||||
|
||||
Your link text should be on a single line. The example below will not work.
|
||||
|
||||
```markdown
|
||||
[Contribution
|
||||
guidelines for this project](docs/CONTRIBUTING.md)
|
||||
```
|
||||
|
||||
Relative links are easier for users who clone your repository. Absolute links may not work in clones of your repository - we recommend using relative links to refer to other files within your repository.
|
||||
|
||||
## Custom anchors
|
||||
|
||||
You can use standard HTML anchor tags (`<a name="unique-anchor-name"></a>`) to create navigation anchor points for any location in the document. To avoid ambiguous references, use a unique naming scheme for anchor tags, such as adding a prefix to the `name` attribute value.
|
||||
|
||||
> \[!NOTE]
|
||||
> Custom anchors will not be included in the document outline/Table of Contents.
|
||||
|
||||
You can link to a custom anchor using the value of the `name` attribute you gave the anchor. The syntax is exactly the same as when you link to an anchor that is automatically generated for a heading.
|
||||
|
||||
For example:
|
||||
|
||||
```markdown
|
||||
# Section Heading
|
||||
|
||||
Some body text of this section.
|
||||
|
||||
<a name="my-custom-anchor-point"></a>
|
||||
Some text I want to provide a direct link to, but which doesn't have its own heading.
|
||||
|
||||
(… more content…)
|
||||
|
||||
[A link to that custom anchor](#my-custom-anchor-point)
|
||||
```
|
||||
|
||||
> \[!TIP]
|
||||
> Custom anchors are not considered by the automatic naming and numbering behavior of automatic heading links.
|
||||
|
||||
## Line breaks
|
||||
|
||||
If you're writing in issues, pull requests, or discussions in a repository, GitHub will render a line break automatically:
|
||||
|
||||
```markdown
|
||||
This example
|
||||
Will span two lines
|
||||
```
|
||||
|
||||
However, if you are writing in an .md file, the example above would render on one line without a line break. To create a line break in an .md file, you will need to include one of the following:
|
||||
|
||||
* Include two spaces at the end of the first line.
|
||||
<pre>
|
||||
This example
|
||||
Will span two lines
|
||||
</pre>
|
||||
|
||||
* Include a backslash at the end of the first line.
|
||||
|
||||
```markdown
|
||||
This example\
|
||||
Will span two lines
|
||||
```
|
||||
|
||||
* Include an HTML single line break tag at the end of the first line.
|
||||
|
||||
```markdown
|
||||
This example<br/>
|
||||
Will span two lines
|
||||
```
|
||||
|
||||
If you leave a blank line between two lines, both .md files and Markdown in issues, pull requests, and discussions will render the two lines separated by the blank line:
|
||||
|
||||
```markdown
|
||||
This example
|
||||
|
||||
Will have a blank line separating both lines
|
||||
```
|
||||
|
||||
## Images
|
||||
|
||||
You can display an image by adding <kbd>!</kbd> and wrapping the alt text in `[ ]`. Alt text is a short text equivalent of the information in the image. Then, wrap the link for the image in parentheses `()`.
|
||||
|
||||
``
|
||||
|
||||
|
||||
|
||||
GitHub supports embedding images into your issues, pull requests, discussions, comments and `.md` files. You can display an image from your repository, add a link to an online image, or upload an image. For more information, see [Uploading assets](#uploading-assets).
|
||||
|
||||
> \[!NOTE]
|
||||
> When you want to display an image that is in your repository, use relative links instead of absolute links.
|
||||
|
||||
Here are some examples for using relative links to display an image.
|
||||
|
||||
| Context | Relative Link |
|
||||
| ----------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||
| In a `.md` file on the same branch | `/assets/images/electrocat.png` |
|
||||
| In a `.md` file on another branch | `/../main/assets/images/electrocat.png` |
|
||||
| In issues, pull requests and comments of the repository | `../blob/main/assets/images/electrocat.png?raw=true` |
|
||||
| In a `.md` file in another repository | `/../../../../github/docs/blob/main/assets/images/electrocat.png` |
|
||||
| In issues, pull requests and comments of another repository | `../../../github/docs/blob/main/assets/images/electrocat.png?raw=true` |
|
||||
|
||||
> \[!NOTE]
|
||||
> The last two relative links in the table above will work for images in a private repository only if the viewer has at least read access to the private repository that contains these images.
|
||||
|
||||
For more information, see [Relative Links](#relative-links).
|
||||
|
||||
### The Picture element
|
||||
|
||||
The `<picture>` HTML element is supported.
|
||||
|
||||
## Lists
|
||||
|
||||
You can make an unordered list by preceding one or more lines of text with <kbd>-</kbd>, <kbd>\*</kbd>, or <kbd>+</kbd>.
|
||||
|
||||
```markdown
|
||||
- George Washington
|
||||
* John Adams
|
||||
+ Thomas Jefferson
|
||||
```
|
||||
|
||||
|
||||
|
||||
To order your list, precede each line with a number.
|
||||
|
||||
```markdown
|
||||
1. James Madison
|
||||
2. James Monroe
|
||||
3. John Quincy Adams
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Nested Lists
|
||||
|
||||
You can create a nested list by indenting one or more list items below another item.
|
||||
|
||||
To create a nested list using the web editor on GitHub or a text editor that uses a monospaced font, like [Visual Studio Code](https://code.visualstudio.com/), you can align your list visually. Type space characters in front of your nested list item until the list marker character (<kbd>-</kbd> or <kbd>\*</kbd>) lies directly below the first character of the text in the item above it.
|
||||
|
||||
```markdown
|
||||
1. First list item
|
||||
- First nested list item
|
||||
- Second nested list item
|
||||
```
|
||||
|
||||
> \[!NOTE]
|
||||
> In the web-based editor, you can indent or dedent one or more lines of text by first highlighting the desired lines and then using <kbd>Tab</kbd> or <kbd>Shift</kbd>+<kbd>Tab</kbd> respectively.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
To create a nested list in the comment editor on GitHub, which doesn't use a monospaced font, you can look at the list item immediately above the nested list and count the number of characters that appear before the content of the item. Then type that number of space characters in front of the nested list item.
|
||||
|
||||
In this example, you could add a nested list item under the list item `100. First list item` by indenting the nested list item a minimum of five spaces, since there are five characters (`100. `) before `First list item`.
|
||||
|
||||
```markdown
|
||||
100. First list item
|
||||
- First nested list item
|
||||
```
|
||||
|
||||
|
||||
|
||||
You can create multiple levels of nested lists using the same method. For example, because the first nested list item has seven characters (`␣␣␣␣␣-␣`) before the nested list content `First nested list item`, you would need to indent the second nested list item by at least two more characters (nine spaces minimum).
|
||||
|
||||
```markdown
|
||||
100. First list item
|
||||
- First nested list item
|
||||
- Second nested list item
|
||||
```
|
||||
|
||||
|
||||
|
||||
For more examples, see the [GitHub Flavored Markdown Spec](https://github.github.com/gfm/#example-265).
|
||||
|
||||
## Task lists
|
||||
|
||||
To create a task list, preface list items with a hyphen and space followed by `[ ]`. To mark a task as complete, use `[x]`.
|
||||
|
||||
```markdown
|
||||
- [x] #739
|
||||
- [ ] https://github.com/octo-org/octo-repo/issues/740
|
||||
- [ ] Add delight to the experience when all tasks are complete :tada:
|
||||
```
|
||||
|
||||
|
||||
|
||||
If a task list item description begins with a parenthesis, you'll need to escape it with <kbd>\\</kbd>:
|
||||
|
||||
`- [ ] \(Optional) Open a followup issue`
|
||||
|
||||
For more information, see [About tasklists](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists).
|
||||
|
||||
## Mentioning people and teams
|
||||
|
||||
You can mention a person or [team](https://docs.github.com/en/organizations/organizing-members-into-teams) on GitHub by typing <kbd>@</kbd> plus their username or team name. This will trigger a notification and bring their attention to the conversation. People will also receive a notification if you edit a comment to mention their username or team name. For more information about notifications, see [About notifications](https://docs.github.com/en/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications).
|
||||
|
||||
> \[!NOTE]
|
||||
> A person will only be notified about a mention if the person has read access to the repository and, if the repository is owned by an organization, the person is a member of the organization.
|
||||
|
||||
`@github/support What do you think about these updates?`
|
||||
|
||||
|
||||
|
||||
When you mention a parent team, members of its child teams also receive notifications, simplifying communication with multiple groups of people. For more information, see [About organization teams](https://docs.github.com/en/organizations/organizing-members-into-teams/about-teams).
|
||||
|
||||
Typing an <kbd>@</kbd> symbol will bring up a list of people or teams on a project. The list filters as you type, so once you find the name of the person or team you are looking for, you can use the arrow keys to select it and press either tab or enter to complete the name. For teams, enter the @organization/team-name and all members of that team will get subscribed to the conversation.
|
||||
|
||||
The autocomplete results are restricted to repository collaborators and any other participants on the thread.
|
||||
|
||||
## Referencing issues and pull requests
|
||||
|
||||
You can bring up a list of suggested issues and pull requests within the repository by typing <kbd>#</kbd>. Type the issue or pull request number or title to filter the list, and then press either tab or enter to complete the highlighted result.
|
||||
|
||||
For more information, see [Autolinked references and URLs](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls).
|
||||
|
||||
## Referencing external resources
|
||||
|
||||
If custom autolink references are configured for a repository, then references to external resources, like a JIRA issue or Zendesk ticket, convert into shortened links. To know which autolinks are available in your repository, contact someone with admin permissions to the repository. For more information, see [Configuring autolinks to reference external resources](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources).
|
||||
|
||||
## Uploading assets
|
||||
|
||||
You can upload assets like images by dragging and dropping, selecting from a file browser, or pasting. You can upload assets to issues, pull requests, comments, and `.md` files in your repository.
|
||||
|
||||
## Using emojis
|
||||
|
||||
You can add emoji to your writing by typing `:EMOJICODE:`, a colon followed by the name of the emoji.
|
||||
|
||||
`@octocat :+1: This PR looks great - it's ready to merge! :shipit:`
|
||||
|
||||
|
||||
|
||||
Typing <kbd>:</kbd> will bring up a list of suggested emoji. The list will filter as you type, so once you find the emoji you're looking for, press **Tab** or **Enter** to complete the highlighted result.
|
||||
|
||||
For a full list of available emoji and codes, see [the Emoji-Cheat-Sheet](https://github.com/ikatyang/emoji-cheat-sheet/blob/github-actions-auto-update/README.md).
|
||||
|
||||
## Paragraphs
|
||||
|
||||
You can create a new paragraph by leaving a blank line between lines of text.
|
||||
|
||||
## Footnotes
|
||||
|
||||
You can add footnotes to your content by using this bracket syntax:
|
||||
|
||||
```text
|
||||
Here is a simple footnote[^1].
|
||||
|
||||
A footnote can also have multiple lines[^2].
|
||||
|
||||
[^1]: My reference.
|
||||
[^2]: To add line breaks within a footnote, add 2 spaces to the end of a line.
|
||||
This is a second line.
|
||||
```
|
||||
|
||||
The footnote will render like this:
|
||||
|
||||
|
||||
|
||||
> \[!NOTE]
|
||||
> The position of a footnote in your Markdown does not influence where the footnote will be rendered. You can write a footnote right after your reference to the footnote, and the footnote will still render at the bottom of the Markdown. Footnotes are not supported in wikis.
|
||||
|
||||
## Alerts
|
||||
|
||||
**Alerts**, also sometimes known as **callouts** or **admonitions**, are a Markdown extension based on the blockquote syntax that you can use to emphasize critical information. On GitHub, they are displayed with distinctive colors and icons to indicate the significance of the content.
|
||||
|
||||
Use alerts only when they are crucial for user success and limit them to one or two per article to prevent overloading the reader. Additionally, you should avoid placing alerts consecutively. Alerts cannot be nested within other elements.
|
||||
|
||||
To add an alert, use a special blockquote line specifying the alert type, followed by the alert information in a standard blockquote. Five types of alerts are available:
|
||||
|
||||
```markdown
|
||||
> [!NOTE]
|
||||
> Useful information that users should know, even when skimming content.
|
||||
|
||||
> [!TIP]
|
||||
> Helpful advice for doing things better or more easily.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Key information users need to know to achieve their goal.
|
||||
|
||||
> [!WARNING]
|
||||
> Urgent info that needs immediate user attention to avoid problems.
|
||||
|
||||
> [!CAUTION]
|
||||
> Advises about risks or negative outcomes of certain actions.
|
||||
```
|
||||
|
||||
Here are the rendered alerts:
|
||||
|
||||
|
||||
|
||||
## Hiding content with comments
|
||||
|
||||
You can tell GitHub to hide content from the rendered Markdown by placing the content in an HTML comment.
|
||||
|
||||
```text
|
||||
<!-- This content will not appear in the rendered Markdown -->
|
||||
```
|
||||
|
||||
## Ignoring Markdown formatting
|
||||
|
||||
You can tell GitHub to ignore (or escape) Markdown formatting by using <kbd>\\</kbd> before the Markdown character.
|
||||
|
||||
`Let's rename \*our-new-project\* to \*our-old-project\*.`
|
||||
|
||||
|
||||
|
||||
For more information on backslashes, see Daring Fireball's [Markdown Syntax](https://daringfireball.net/projects/markdown/syntax#backslash).
|
||||
|
||||
> \[!NOTE]
|
||||
> The Markdown formatting will not be ignored in the title of an issue or a pull request.
|
||||
|
||||
## Disabling Markdown rendering
|
||||
|
||||
When viewing a Markdown file, you can click **Code** at the top of the file to disable Markdown rendering and view the file's source instead.
|
||||
|
||||
|
||||
|
||||
Disabling Markdown rendering enables you to use source view features, such as line linking, which is not possible when viewing rendered Markdown files.
|
||||
|
||||
## Further reading
|
||||
|
||||
*[GitHub Flavored Markdown Spec](https://github.github.com/gfm/)
|
||||
*[About writing and formatting on GitHub](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github)
|
||||
*[Working with advanced formatting](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting)
|
||||
*[Quickstart for writing on GitHub](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github)
|
||||
165
skills/markdown-to-html/references/code-blocks-to-html.md
Normal file
165
skills/markdown-to-html/references/code-blocks-to-html.md
Normal file
@@ -0,0 +1,165 @@
|
||||
# Code Blocks to HTML
|
||||
|
||||
## Fenced Code Blocks (No Language)
|
||||
|
||||
### Markdown
|
||||
|
||||
```
|
||||
function test() {
|
||||
console.log("notice the blank line before this function?");
|
||||
}
|
||||
```
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<pre><code>
|
||||
function test() {
|
||||
console.log("notice the blank line before this function?");
|
||||
}
|
||||
</code></pre>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## GitHub Tip Callout
|
||||
|
||||
### Markdown
|
||||
|
||||
```md
|
||||
> [!TIP]
|
||||
> To preserve your formatting within a list, make sure to indent non-fenced code blocks by eight spaces.
|
||||
```
|
||||
|
||||
### Parsed HTML (GitHub-specific)
|
||||
|
||||
```html
|
||||
<blockquote class="markdown-alert markdown-alert-tip">
|
||||
<p><strong>Tip</strong></p>
|
||||
<p>To preserve your formatting within a list, make sure to indent non-fenced code blocks by eight spaces.</p>
|
||||
</blockquote>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Showing Backticks Inside Code Blocks
|
||||
|
||||
### Markdown
|
||||
|
||||
`````md
|
||||
````
|
||||
```
|
||||
Look! You can see my backticks.
|
||||
```
|
||||
````
|
||||
`````
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<pre><code>
|
||||
```
|
||||
|
||||
Look! You can see my backticks.
|
||||
|
||||
```
|
||||
</code></pre>
|
||||
```
|
||||
|
||||
## Syntax Highlighting (Language Identifier)
|
||||
|
||||
### Markdown
|
||||
|
||||
```ruby
|
||||
require 'redcarpet'
|
||||
markdown = Redcarpet.new("Hello World!")
|
||||
puts markdown.to_html
|
||||
```
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<pre><code class="language-ruby">
|
||||
require 'redcarpet'
|
||||
markdown = Redcarpet.new("Hello World!")
|
||||
puts markdown.to_html
|
||||
</code></pre>
|
||||
```
|
||||
|
||||
> The `language-ruby` class is consumed by GitHub’s syntax highlighter (Linguist + grammar).
|
||||
|
||||
### Summary: Syntax-Highlighting Rules (HTML-Level)
|
||||
|
||||
| Markdown fence | Parsed `<code>` tag |
|
||||
| -------------- | ------------------------------ |
|
||||
| ```js | `<code class="language-js">` |
|
||||
| ```html | `<code class="language-html">` |
|
||||
| ```md | `<code class="language-md">` |
|
||||
| ``` (no lang) | `<code>` |
|
||||
|
||||
---
|
||||
|
||||
## HTML Comments (Ignored by Renderer)
|
||||
|
||||
```md
|
||||
<!-- Internal documentation comment -->
|
||||
```
|
||||
|
||||
```html
|
||||
<!-- Internal documentation comment -->
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Links
|
||||
|
||||
```md
|
||||
[About writing and formatting on GitHub](https://docs.github.com/...)
|
||||
```
|
||||
|
||||
```html
|
||||
<a href="https://docs.github.com/...">About writing and formatting on GitHub</a>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Lists
|
||||
|
||||
```md
|
||||
* [GitHub Flavored Markdown Spec](https://github.github.com/gfm/)
|
||||
```
|
||||
|
||||
```html
|
||||
<ul>
|
||||
<li>
|
||||
<a href="https://github.github.com/gfm/">GitHub Flavored Markdown Spec</a>
|
||||
</li>
|
||||
</ul>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Diagrams (Conceptual Parsing)
|
||||
|
||||
### Markdown
|
||||
|
||||
````md
|
||||
```mermaid
|
||||
graph TD
|
||||
A --> B
|
||||
```
|
||||
````
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<pre><code class="language-mermaid">
|
||||
graph TD
|
||||
A --> B
|
||||
</code></pre>
|
||||
```
|
||||
|
||||
## Closing Notes
|
||||
|
||||
* No `language-*` class appears here because **no language identifier** was provided.
|
||||
* The inner triple backticks are preserved **as literal text** inside `<code>`.
|
||||
70
skills/markdown-to-html/references/code-blocks.md
Normal file
70
skills/markdown-to-html/references/code-blocks.md
Normal file
@@ -0,0 +1,70 @@
|
||||
# Creating and highlighting code blocks
|
||||
|
||||
Share samples of code with fenced code blocks and enabling syntax highlighting.
|
||||
|
||||
## Fenced code blocks
|
||||
|
||||
You can create fenced code blocks by placing triple backticks <code>\`\`\`</code> before and after the code block. We recommend placing a blank line before and after code blocks to make the raw formatting easier to read.
|
||||
|
||||
````text
|
||||
```
|
||||
function test() {
|
||||
console.log("notice the blank line before this function?");
|
||||
}
|
||||
```
|
||||
````
|
||||
|
||||
|
||||
|
||||
> \[!TIP]
|
||||
> To preserve your formatting within a list, make sure to indent non-fenced code blocks by eight spaces.
|
||||
|
||||
To display triple backticks in a fenced code block, wrap them inside quadruple backticks.
|
||||
|
||||
`````text
|
||||
````
|
||||
```
|
||||
Look! You can see my backticks.
|
||||
```
|
||||
````
|
||||
`````
|
||||
|
||||
|
||||
|
||||
If you are frequently editing code snippets and tables, you may benefit from enabling a fixed-width font in all comment fields on GitHub. For more information, see [About writing and formatting on GitHub](https://docs.github.com/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github#enabling-fixed-width-fonts-in-the-editor).
|
||||
|
||||
## Syntax highlighting
|
||||
|
||||
<!-- If you make changes to this feature, check whether any of the changes affect languages listed in /get-started/learning-about-github/github-language-support. If so, please update the language support article accordingly. -->
|
||||
|
||||
You can add an optional language identifier to enable syntax highlighting in your fenced code block.
|
||||
|
||||
Syntax highlighting changes the color and style of source code to make it easier to read.
|
||||
|
||||
For example, to syntax highlight Ruby code:
|
||||
|
||||
````text
|
||||
```ruby
|
||||
require 'redcarpet'
|
||||
markdown = Redcarpet.new("Hello World!")
|
||||
puts markdown.to_html
|
||||
```
|
||||
````
|
||||
|
||||
This will display the code block with syntax highlighting:
|
||||
|
||||
|
||||
|
||||
> \[!TIP]
|
||||
> When you create a fenced code block that you also want to have syntax highlighting on a GitHub Pages site, use lower-case language identifiers. For more information, see [About GitHub Pages and Jekyll](https://docs.github.com/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll#syntax-highlighting).
|
||||
|
||||
We use [Linguist](https://github.com/github-linguist/linguist) to perform language detection and to select [third-party grammars](https://github.com/github-linguist/linguist/blob/main/vendor/README.md) for syntax highlighting. You can find out which keywords are valid in [the languages YAML file](https://github.com/github-linguist/linguist/blob/main/lib/linguist/languages.yml).
|
||||
|
||||
## Creating diagrams
|
||||
|
||||
You can also use code blocks to create diagrams in Markdown. GitHub supports Mermaid, GeoJSON, TopoJSON, and ASCII STL syntax. For more information, see [Creating diagrams](https://docs.github.com/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams).
|
||||
|
||||
## Further reading
|
||||
|
||||
* [GitHub Flavored Markdown Spec](https://github.github.com/gfm/)
|
||||
* [Basic writing and formatting syntax](https://docs.github.com/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
|
||||
136
skills/markdown-to-html/references/collapsed-sections-to-html.md
Normal file
136
skills/markdown-to-html/references/collapsed-sections-to-html.md
Normal file
@@ -0,0 +1,136 @@
|
||||
# Collapsed Sections to HTML
|
||||
|
||||
## `<details>` Block (Raw HTML in Markdown)
|
||||
|
||||
### Markdown
|
||||
|
||||
````md
|
||||
<details>
|
||||
|
||||
<summary>Tips for collapsed sections</summary>
|
||||
|
||||
### You can add a header
|
||||
|
||||
You can add text within a collapsed section.
|
||||
|
||||
You can add an image or a code block, too.
|
||||
|
||||
```ruby
|
||||
puts "Hello World"
|
||||
```
|
||||
|
||||
</details>
|
||||
````
|
||||
|
||||
---
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<details>
|
||||
<summary>Tips for collapsed sections</summary>
|
||||
|
||||
<h3>You can add a header</h3>
|
||||
|
||||
<p>You can add text within a collapsed section.</p>
|
||||
|
||||
<p>You can add an image or a code block, too.</p>
|
||||
|
||||
<pre><code class="language-ruby">
|
||||
puts "Hello World"
|
||||
</code></pre>
|
||||
</details>
|
||||
```
|
||||
|
||||
#### Notes:
|
||||
|
||||
* Markdown **inside `<details>`** is still parsed normally.
|
||||
* Syntax highlighting is preserved via `class="language-ruby"`.
|
||||
|
||||
---
|
||||
|
||||
## Open by Default (`open` attribute)
|
||||
|
||||
### Markdown
|
||||
|
||||
````md
|
||||
<details open>
|
||||
|
||||
<summary>Tips for collapsed sections</summary>
|
||||
|
||||
### You can add a header
|
||||
|
||||
You can add text within a collapsed section.
|
||||
|
||||
You can add an image or a code block, too.
|
||||
|
||||
```ruby
|
||||
puts "Hello World"
|
||||
```
|
||||
|
||||
</details>
|
||||
````
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<details open>
|
||||
<summary>Tips for collapsed sections</summary>
|
||||
|
||||
<h3>You can add a header</h3>
|
||||
|
||||
<p>You can add text within a collapsed section.</p>
|
||||
|
||||
<p>You can add an image or a code block, too.</p>
|
||||
|
||||
<pre><code class="language-ruby">
|
||||
puts "Hello World"
|
||||
</code></pre>
|
||||
</details>
|
||||
```
|
||||
|
||||
## Key Rules
|
||||
|
||||
* `<details>` and `<summary>` are **raw HTML**, not Markdown syntax
|
||||
* Markdown inside `<details>` **is still parsed**
|
||||
* Syntax highlighting works normally inside collapsed sections
|
||||
* Use `<summary>` as the **clickable label**
|
||||
|
||||
## Paragraphs with Inline HTML & SVG
|
||||
|
||||
### Markdown
|
||||
|
||||
```md
|
||||
You can streamline your Markdown by creating a collapsed section with the `<details>` tag.
|
||||
```
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<p>
|
||||
You can streamline your Markdown by creating a collapsed section with the <code><details></code> tag.
|
||||
</p>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Markdown (inline SVG preserved)
|
||||
|
||||
```md
|
||||
Any Markdown within the `<details>` block will be collapsed until the reader clicks <svg ...></svg> to expand the details.
|
||||
```
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<p>
|
||||
Any Markdown within the <code><details></code> block will be collapsed until the reader clicks
|
||||
<svg version="1.1" width="16" height="16" viewBox="0 0 16 16"
|
||||
class="octicon octicon-triangle-right"
|
||||
aria-label="The right triangle icon"
|
||||
role="img">
|
||||
<path d="m6.427 4.427 3.396 3.396a.25.25 0 0 1 0 .354l-3.396 3.396A.25.25 0 0 1 6 11.396V4.604a.25.25 0 0 1 .427-.177Z"></path>
|
||||
</svg>
|
||||
to expand the details.
|
||||
</p>
|
||||
```
|
||||
48
skills/markdown-to-html/references/collapsed-sections.md
Normal file
48
skills/markdown-to-html/references/collapsed-sections.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# Organizing information with collapsed sections
|
||||
|
||||
You can streamline your Markdown by creating a collapsed section with the `<details>` tag.
|
||||
|
||||
## Creating a collapsed section
|
||||
|
||||
You can temporarily obscure sections of your Markdown by creating a collapsed section that the reader can choose to expand. For example, when you want to include technical details in an issue comment that may not be relevant or interesting to every reader, you can put those details in a collapsed section.
|
||||
|
||||
Any Markdown within the `<details>` block will be collapsed until the reader clicks <svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-triangle-right" aria-label="The right triangle icon" role="img"><path d="m6.427 4.427 3.396 3.396a.25.25 0 0 1 0 .354l-3.396 3.396A.25.25 0 0 1 6 11.396V4.604a.25.25 0 0 1 .427-.177Z"></path></svg> to expand the details.
|
||||
|
||||
Within the `<details>` block, use the `<summary>` tag to let readers know what is inside. The label appears to the right of <svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-triangle-right" aria-label="The right triangle icon" role="img"><path d="m6.427 4.427 3.396 3.396a.25.25 0 0 1 0 .354l-3.396 3.396A.25.25 0 0 1 6 11.396V4.604a.25.25 0 0 1 .427-.177Z"></path></svg>.
|
||||
|
||||
````markdown
|
||||
<details>
|
||||
|
||||
<summary>Tips for collapsed sections</summary>
|
||||
|
||||
### You can add a header
|
||||
|
||||
You can add text within a collapsed section.
|
||||
|
||||
You can add an image or a code block, too.
|
||||
|
||||
```ruby
|
||||
puts "Hello World"
|
||||
```
|
||||
|
||||
</details>
|
||||
````
|
||||
|
||||
The Markdown inside the `<summary>` label will be collapsed by default:
|
||||
|
||||
|
||||
|
||||
After a reader clicks <svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-triangle-right" aria-label="The right triangle icon" role="img"><path d="m6.427 4.427 3.396 3.396a.25.25 0 0 1 0 .354l-3.396 3.396A.25.25 0 0 1 6 11.396V4.604a.25.25 0 0 1 .427-.177Z"></path></svg>, the details are expanded:
|
||||
|
||||
|
||||
|
||||
Optionally, to make the section display as open by default, add the `open` attribute to the `<details>` tag:
|
||||
|
||||
```html
|
||||
<details open>
|
||||
```
|
||||
|
||||
## Further reading
|
||||
|
||||
* [GitHub Flavored Markdown Spec](https://github.github.com/gfm/)
|
||||
* [Basic writing and formatting syntax](https://docs.github.com/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
|
||||
253
skills/markdown-to-html/references/gomarkdown.md
Normal file
253
skills/markdown-to-html/references/gomarkdown.md
Normal file
@@ -0,0 +1,253 @@
|
||||
# gomarkdown/markdown Reference
|
||||
|
||||
Go library for parsing Markdown and rendering HTML. Fast, extensible, and thread-safe.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
# Add to your Go project
|
||||
go get github.com/gomarkdown/markdown
|
||||
|
||||
# Install CLI tool
|
||||
go install github.com/gomarkdown/mdtohtml@latest
|
||||
```
|
||||
|
||||
## Basic Usage
|
||||
|
||||
### Simple Conversion
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"github.com/gomarkdown/markdown"
|
||||
)
|
||||
|
||||
func main() {
|
||||
md := []byte("# Hello World\n\nThis is **bold** text.")
|
||||
html := markdown.ToHTML(md, nil, nil)
|
||||
fmt.Println(string(html))
|
||||
}
|
||||
```
|
||||
|
||||
### Using CLI Tool
|
||||
|
||||
```bash
|
||||
# Convert file to HTML
|
||||
mdtohtml input.md output.html
|
||||
|
||||
# Output to stdout
|
||||
mdtohtml input.md
|
||||
```
|
||||
|
||||
## Parser Configuration
|
||||
|
||||
### Common Extensions
|
||||
|
||||
```go
|
||||
import (
|
||||
"github.com/gomarkdown/markdown"
|
||||
"github.com/gomarkdown/markdown/parser"
|
||||
)
|
||||
|
||||
// Create parser with extensions
|
||||
extensions := parser.CommonExtensions | parser.AutoHeadingIDs
|
||||
p := parser.NewWithExtensions(extensions)
|
||||
|
||||
// Parse markdown
|
||||
doc := p.Parse(md)
|
||||
```
|
||||
|
||||
### Available Parser Extensions
|
||||
|
||||
| Extension | Description |
|
||||
|-----------|-------------|
|
||||
| `parser.CommonExtensions` | Tables, fenced code, autolinks, strikethrough |
|
||||
| `parser.Tables` | Pipe tables support |
|
||||
| `parser.FencedCode` | Fenced code blocks with language |
|
||||
| `parser.Autolink` | Auto-detect URLs |
|
||||
| `parser.Strikethrough` | ~~strikethrough~~ text |
|
||||
| `parser.SpaceHeadings` | Require space after # in headings |
|
||||
| `parser.HeadingIDs` | Custom heading IDs {#id} |
|
||||
| `parser.AutoHeadingIDs` | Auto-generate heading IDs |
|
||||
| `parser.Footnotes` | Footnote support |
|
||||
| `parser.NoEmptyLineBeforeBlock` | No blank line required before blocks |
|
||||
| `parser.HardLineBreak` | Newlines become `<br>` |
|
||||
| `parser.MathJax` | MathJax support |
|
||||
| `parser.SuperSubscript` | Super^script^ and sub~script~ |
|
||||
| `parser.Mmark` | Mmark syntax support |
|
||||
|
||||
## HTML Renderer Configuration
|
||||
|
||||
### Common Flags
|
||||
|
||||
```go
|
||||
import (
|
||||
"github.com/gomarkdown/markdown"
|
||||
"github.com/gomarkdown/markdown/html"
|
||||
"github.com/gomarkdown/markdown/parser"
|
||||
)
|
||||
|
||||
// Parser
|
||||
p := parser.NewWithExtensions(parser.CommonExtensions)
|
||||
|
||||
// Renderer
|
||||
htmlFlags := html.CommonFlags | html.HrefTargetBlank
|
||||
opts := html.RendererOptions{
|
||||
Flags: htmlFlags,
|
||||
Title: "My Document",
|
||||
CSS: "style.css",
|
||||
}
|
||||
renderer := html.NewRenderer(opts)
|
||||
|
||||
// Convert
|
||||
html := markdown.ToHTML(md, p, renderer)
|
||||
```
|
||||
|
||||
### Available HTML Flags
|
||||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `html.CommonFlags` | Common sensible defaults |
|
||||
| `html.HrefTargetBlank` | Add `target="_blank"` to links |
|
||||
| `html.CompletePage` | Generate complete HTML document |
|
||||
| `html.UseXHTML` | Use XHTML output |
|
||||
| `html.FootnoteReturnLinks` | Add return links in footnotes |
|
||||
| `html.FootnoteNoHRTag` | No `<hr>` before footnotes |
|
||||
| `html.Smartypants` | Smart punctuation |
|
||||
| `html.SmartypantsFractions` | Smart fractions (1/2 → ½) |
|
||||
| `html.SmartypantsDashes` | Smart dashes (-- → –) |
|
||||
| `html.SmartypantsLatexDashes` | LaTeX-style dashes |
|
||||
|
||||
### Renderer Options
|
||||
|
||||
```go
|
||||
opts := html.RendererOptions{
|
||||
Flags: htmlFlags,
|
||||
Title: "Document Title",
|
||||
CSS: "path/to/style.css",
|
||||
Icon: "favicon.ico",
|
||||
Head: []byte("<meta name='author' content='...'>"),
|
||||
RenderNodeHook: customRenderHook,
|
||||
}
|
||||
```
|
||||
|
||||
## Complete Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"os"
|
||||
"github.com/gomarkdown/markdown"
|
||||
"github.com/gomarkdown/markdown/html"
|
||||
"github.com/gomarkdown/markdown/parser"
|
||||
)
|
||||
|
||||
func mdToHTML(md []byte) []byte {
|
||||
// Parser with extensions
|
||||
extensions := parser.CommonExtensions |
|
||||
parser.AutoHeadingIDs |
|
||||
parser.NoEmptyLineBeforeBlock
|
||||
p := parser.NewWithExtensions(extensions)
|
||||
doc := p.Parse(md)
|
||||
|
||||
// HTML renderer with options
|
||||
htmlFlags := html.CommonFlags | html.HrefTargetBlank
|
||||
opts := html.RendererOptions{Flags: htmlFlags}
|
||||
renderer := html.NewRenderer(opts)
|
||||
|
||||
return markdown.Render(doc, renderer)
|
||||
}
|
||||
|
||||
func main() {
|
||||
md, _ := os.ReadFile("input.md")
|
||||
html := mdToHTML(md)
|
||||
os.WriteFile("output.html", html, 0644)
|
||||
}
|
||||
```
|
||||
|
||||
## Security: Sanitizing Output
|
||||
|
||||
**Important:** gomarkdown does not sanitize HTML output. Use Bluemonday for untrusted input:
|
||||
|
||||
```go
|
||||
import (
|
||||
"github.com/microcosm-cc/bluemonday"
|
||||
"github.com/gomarkdown/markdown"
|
||||
)
|
||||
|
||||
// Convert markdown to potentially unsafe HTML
|
||||
unsafeHTML := markdown.ToHTML(md, nil, nil)
|
||||
|
||||
// Sanitize using Bluemonday
|
||||
p := bluemonday.UGCPolicy()
|
||||
safeHTML := p.SanitizeBytes(unsafeHTML)
|
||||
```
|
||||
|
||||
### Bluemonday Policies
|
||||
|
||||
| Policy | Description |
|
||||
|--------|-------------|
|
||||
| `UGCPolicy()` | User-generated content (most common) |
|
||||
| `StrictPolicy()` | Strip all HTML |
|
||||
| `StripTagsPolicy()` | Strip tags, keep text |
|
||||
| `NewPolicy()` | Build custom policy |
|
||||
|
||||
## Working with AST
|
||||
|
||||
### Accessing the AST
|
||||
|
||||
```go
|
||||
import (
|
||||
"github.com/gomarkdown/markdown/ast"
|
||||
"github.com/gomarkdown/markdown/parser"
|
||||
)
|
||||
|
||||
p := parser.NewWithExtensions(parser.CommonExtensions)
|
||||
doc := p.Parse(md)
|
||||
|
||||
// Walk the AST
|
||||
ast.WalkFunc(doc, func(node ast.Node, entering bool) ast.WalkStatus {
|
||||
if heading, ok := node.(*ast.Heading); ok && entering {
|
||||
fmt.Printf("Found heading level %d\n", heading.Level)
|
||||
}
|
||||
return ast.GoToNext
|
||||
})
|
||||
```
|
||||
|
||||
### Custom Renderer
|
||||
|
||||
```go
|
||||
type MyRenderer struct {
|
||||
*html.Renderer
|
||||
}
|
||||
|
||||
func (r *MyRenderer) RenderNode(w io.Writer, node ast.Node, entering bool) ast.WalkStatus {
|
||||
// Custom rendering logic
|
||||
if heading, ok := node.(*ast.Heading); ok && entering {
|
||||
fmt.Fprintf(w, "<h%d class='custom'>", heading.Level)
|
||||
return ast.GoToNext
|
||||
}
|
||||
return r.Renderer.RenderNode(w, node, entering)
|
||||
}
|
||||
```
|
||||
|
||||
## Handling Newlines
|
||||
|
||||
Windows and Mac newlines need normalization:
|
||||
|
||||
```go
|
||||
// Normalize newlines before parsing
|
||||
normalized := parser.NormalizeNewlines(input)
|
||||
html := markdown.ToHTML(normalized, nil, nil)
|
||||
```
|
||||
|
||||
## Resources
|
||||
|
||||
- [Package Documentation](https://pkg.go.dev/github.com/gomarkdown/markdown)
|
||||
- [Advanced Processing Guide](https://blog.kowalczyk.info/article/cxn3/advanced-markdown-processing-in-go.html)
|
||||
- [GitHub Repository](https://github.com/gomarkdown/markdown)
|
||||
- [CLI Tool](https://github.com/gomarkdown/mdtohtml)
|
||||
- [Bluemonday Sanitizer](https://github.com/microcosm-cc/bluemonday)
|
||||
394
skills/markdown-to-html/references/hugo.md
Normal file
394
skills/markdown-to-html/references/hugo.md
Normal file
@@ -0,0 +1,394 @@
|
||||
# Hugo Reference
|
||||
|
||||
Hugo is the world's fastest static site generator. It builds sites in milliseconds and supports advanced content management features.
|
||||
|
||||
## Installation
|
||||
|
||||
### Windows
|
||||
|
||||
```powershell
|
||||
# Using Chocolatey
|
||||
choco install hugo-extended
|
||||
|
||||
# Using Scoop
|
||||
scoop install hugo-extended
|
||||
|
||||
# Using Winget
|
||||
winget install Hugo.Hugo.Extended
|
||||
```
|
||||
|
||||
### macOS
|
||||
|
||||
```bash
|
||||
# Using Homebrew
|
||||
brew install hugo
|
||||
```
|
||||
|
||||
### Linux
|
||||
|
||||
```bash
|
||||
# Debian/Ubuntu (snap)
|
||||
snap install hugo --channel=extended
|
||||
|
||||
# Using package manager (may not be latest)
|
||||
sudo apt-get install hugo
|
||||
|
||||
# Or download from https://gohugo.io/installation/
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Create New Site
|
||||
|
||||
```bash
|
||||
# Create site
|
||||
hugo new site mysite
|
||||
cd mysite
|
||||
|
||||
# Initialize git and add theme
|
||||
git init
|
||||
git submodule add https://github.com/theNewDynamic/gohugo-theme-ananke themes/ananke
|
||||
echo "theme = 'ananke'" >> hugo.toml
|
||||
|
||||
# Create first post
|
||||
hugo new content posts/my-first-post.md
|
||||
|
||||
# Start development server
|
||||
hugo server -D
|
||||
```
|
||||
|
||||
### Directory Structure
|
||||
|
||||
```
|
||||
mysite/
|
||||
├── archetypes/ # Content templates
|
||||
│ └── default.md
|
||||
├── assets/ # Assets to process (SCSS, JS)
|
||||
├── content/ # Markdown content
|
||||
│ └── posts/
|
||||
├── data/ # Data files (YAML, JSON, TOML)
|
||||
├── i18n/ # Internationalization
|
||||
├── layouts/ # Templates
|
||||
│ ├── _default/
|
||||
│ ├── partials/
|
||||
│ └── shortcodes/
|
||||
├── static/ # Static files (copied as-is)
|
||||
├── themes/ # Themes
|
||||
└── hugo.toml # Configuration
|
||||
```
|
||||
|
||||
## CLI Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `hugo new site <name>` | Create new site |
|
||||
| `hugo new content <path>` | Create content file |
|
||||
| `hugo` | Build to `public/` |
|
||||
| `hugo server` | Start dev server |
|
||||
| `hugo mod init` | Initialize Hugo Modules |
|
||||
| `hugo mod tidy` | Clean up modules |
|
||||
|
||||
### Build Options
|
||||
|
||||
```bash
|
||||
# Basic build
|
||||
hugo
|
||||
|
||||
# Build with minification
|
||||
hugo --minify
|
||||
|
||||
# Build with drafts
|
||||
hugo -D
|
||||
|
||||
# Build for specific environment
|
||||
hugo --environment production
|
||||
|
||||
# Build to custom directory
|
||||
hugo -d ./dist
|
||||
|
||||
# Verbose output
|
||||
hugo -v
|
||||
```
|
||||
|
||||
### Server Options
|
||||
|
||||
```bash
|
||||
# Start with drafts
|
||||
hugo server -D
|
||||
|
||||
# Bind to all interfaces
|
||||
hugo server --bind 0.0.0.0
|
||||
|
||||
# Custom port
|
||||
hugo server --port 8080
|
||||
|
||||
# Disable live reload
|
||||
hugo server --disableLiveReload
|
||||
|
||||
# Navigate to changed content
|
||||
hugo server --navigateToChanged
|
||||
```
|
||||
|
||||
## Configuration (hugo.toml)
|
||||
|
||||
```toml
|
||||
# Basic settings
|
||||
baseURL = 'https://example.com/'
|
||||
languageCode = 'en-us'
|
||||
title = 'My Hugo Site'
|
||||
theme = 'ananke'
|
||||
|
||||
# Build settings
|
||||
[build]
|
||||
writeStats = true
|
||||
|
||||
# Markdown configuration
|
||||
[markup]
|
||||
[markup.goldmark]
|
||||
[markup.goldmark.extensions]
|
||||
definitionList = true
|
||||
footnote = true
|
||||
linkify = true
|
||||
strikethrough = true
|
||||
table = true
|
||||
taskList = true
|
||||
[markup.goldmark.parser]
|
||||
autoHeadingID = true
|
||||
autoHeadingIDType = 'github'
|
||||
[markup.goldmark.renderer]
|
||||
unsafe = false
|
||||
[markup.highlight]
|
||||
style = 'monokai'
|
||||
lineNos = true
|
||||
|
||||
# Taxonomies
|
||||
[taxonomies]
|
||||
category = 'categories'
|
||||
tag = 'tags'
|
||||
author = 'authors'
|
||||
|
||||
# Menus
|
||||
[menus]
|
||||
[[menus.main]]
|
||||
name = 'Home'
|
||||
pageRef = '/'
|
||||
weight = 10
|
||||
[[menus.main]]
|
||||
name = 'Posts'
|
||||
pageRef = '/posts'
|
||||
weight = 20
|
||||
|
||||
# Parameters
|
||||
[params]
|
||||
description = 'My awesome site'
|
||||
author = 'John Doe'
|
||||
```
|
||||
|
||||
## Front Matter
|
||||
|
||||
Hugo supports TOML, YAML, and JSON front matter:
|
||||
|
||||
### TOML (default)
|
||||
|
||||
```markdown
|
||||
+++
|
||||
title = 'My First Post'
|
||||
date = 2025-01-28T12:00:00-05:00
|
||||
draft = false
|
||||
tags = ['hugo', 'tutorial']
|
||||
categories = ['blog']
|
||||
author = 'John Doe'
|
||||
+++
|
||||
|
||||
Content here...
|
||||
```
|
||||
|
||||
### YAML
|
||||
|
||||
```markdown
|
||||
---
|
||||
title: "My First Post"
|
||||
date: 2025-01-28T12:00:00-05:00
|
||||
draft: false
|
||||
tags: ["hugo", "tutorial"]
|
||||
---
|
||||
|
||||
Content here...
|
||||
```
|
||||
|
||||
## Templates
|
||||
|
||||
### Base Template (_default/baseof.html)
|
||||
|
||||
```html
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>{{ .Title }} | {{ .Site.Title }}</title>
|
||||
{{ partial "head.html" . }}
|
||||
</head>
|
||||
<body>
|
||||
{{ partial "header.html" . }}
|
||||
<main>
|
||||
{{ block "main" . }}{{ end }}
|
||||
</main>
|
||||
{{ partial "footer.html" . }}
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
### Single Page (_default/single.html)
|
||||
|
||||
```html
|
||||
{{ define "main" }}
|
||||
<article>
|
||||
<h1>{{ .Title }}</h1>
|
||||
<time>{{ .Date.Format "January 2, 2006" }}</time>
|
||||
{{ .Content }}
|
||||
</article>
|
||||
{{ end }}
|
||||
```
|
||||
|
||||
### List Page (_default/list.html)
|
||||
|
||||
```html
|
||||
{{ define "main" }}
|
||||
<h1>{{ .Title }}</h1>
|
||||
{{ range .Pages }}
|
||||
<article>
|
||||
<h2><a href="{{ .Permalink }}">{{ .Title }}</a></h2>
|
||||
<p>{{ .Summary }}</p>
|
||||
</article>
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
```
|
||||
|
||||
## Shortcodes
|
||||
|
||||
### Built-in Shortcodes
|
||||
|
||||
```markdown
|
||||
{{< figure src="/images/photo.jpg" title="My Photo" >}}
|
||||
|
||||
{{< youtube dQw4w9WgXcQ >}}
|
||||
|
||||
{{< gist user 12345 >}}
|
||||
|
||||
{{< highlight go >}}
|
||||
fmt.Println("Hello")
|
||||
{{< /highlight >}}
|
||||
```
|
||||
|
||||
### Custom Shortcode (layouts/shortcodes/alert.html)
|
||||
|
||||
```html
|
||||
<div class="alert alert-{{ .Get "type" | default "info" }}">
|
||||
{{ .Inner | markdownify }}
|
||||
</div>
|
||||
```
|
||||
|
||||
Usage:
|
||||
|
||||
```markdown
|
||||
{{< alert type="warning" >}}
|
||||
**Warning:** This is important!
|
||||
{{< /alert >}}
|
||||
```
|
||||
|
||||
## Content Organization
|
||||
|
||||
### Page Bundles
|
||||
|
||||
```
|
||||
content/
|
||||
├── posts/
|
||||
│ └── my-post/ # Page bundle
|
||||
│ ├── index.md # Content
|
||||
│ └── image.jpg # Resources
|
||||
└── _index.md # Section page
|
||||
```
|
||||
|
||||
### Accessing Resources
|
||||
|
||||
```html
|
||||
{{ $image := .Resources.GetMatch "image.jpg" }}
|
||||
{{ with $image }}
|
||||
<img src="{{ .RelPermalink }}" alt="...">
|
||||
{{ end }}
|
||||
```
|
||||
|
||||
## Hugo Pipes (Asset Processing)
|
||||
|
||||
### SCSS Compilation
|
||||
|
||||
```html
|
||||
{{ $styles := resources.Get "scss/main.scss" | toCSS | minify }}
|
||||
<link rel="stylesheet" href="{{ $styles.RelPermalink }}">
|
||||
```
|
||||
|
||||
### JavaScript Bundling
|
||||
|
||||
```html
|
||||
{{ $js := resources.Get "js/main.js" | js.Build | minify }}
|
||||
<script src="{{ $js.RelPermalink }}"></script>
|
||||
```
|
||||
|
||||
## Taxonomies
|
||||
|
||||
### Configure
|
||||
|
||||
```toml
|
||||
[taxonomies]
|
||||
tag = 'tags'
|
||||
category = 'categories'
|
||||
```
|
||||
|
||||
### Use in Front Matter
|
||||
|
||||
```markdown
|
||||
+++
|
||||
tags = ['go', 'hugo']
|
||||
categories = ['tutorials']
|
||||
+++
|
||||
```
|
||||
|
||||
### List Taxonomy Terms
|
||||
|
||||
```html
|
||||
{{ range .Site.Taxonomies.tags }}
|
||||
<a href="{{ .Page.Permalink }}">{{ .Page.Title }} ({{ .Count }})</a>
|
||||
{{ end }}
|
||||
```
|
||||
|
||||
## Multilingual Sites
|
||||
|
||||
```toml
|
||||
defaultContentLanguage = 'en'
|
||||
|
||||
[languages]
|
||||
[languages.en]
|
||||
title = 'My Site'
|
||||
weight = 1
|
||||
[languages.es]
|
||||
title = 'Mi Sitio'
|
||||
weight = 2
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
| Issue | Solution |
|
||||
|-------|----------|
|
||||
| Page not found | Check `baseURL` configuration |
|
||||
| Theme not loading | Verify theme path in config |
|
||||
| Raw HTML not showing | Set `unsafe = true` in goldmark config |
|
||||
| Slow builds | Use `--templateMetrics` to debug |
|
||||
| Module errors | Run `hugo mod tidy` |
|
||||
| CSS not updating | Clear browser cache or use fingerprinting |
|
||||
|
||||
## Resources
|
||||
|
||||
- [Hugo Documentation](https://gohugo.io/documentation/)
|
||||
- [Hugo Themes](https://themes.gohugo.io/)
|
||||
- [Hugo Discourse](https://discourse.gohugo.io/)
|
||||
- [GitHub Repository](https://github.com/gohugoio/hugo)
|
||||
- [Quick Reference](https://gohugo.io/quick-reference/)
|
||||
321
skills/markdown-to-html/references/jekyll.md
Normal file
321
skills/markdown-to-html/references/jekyll.md
Normal file
@@ -0,0 +1,321 @@
|
||||
# Jekyll Reference
|
||||
|
||||
Jekyll is a static site generator that transforms Markdown content into complete websites. It's blog-aware and powers GitHub Pages.
|
||||
|
||||
## Installation
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Ruby 2.7.0 or higher
|
||||
- RubyGems
|
||||
- GCC and Make
|
||||
|
||||
### Install Jekyll
|
||||
|
||||
```bash
|
||||
# Install Jekyll and Bundler
|
||||
gem install jekyll bundler
|
||||
```
|
||||
|
||||
### Platform-Specific Installation
|
||||
|
||||
```bash
|
||||
# macOS (install Xcode CLI tools first)
|
||||
xcode-select --install
|
||||
gem install jekyll bundler
|
||||
|
||||
# Ubuntu/Debian
|
||||
sudo apt-get install ruby-full build-essential zlib1g-dev
|
||||
gem install jekyll bundler
|
||||
|
||||
# Windows (use RubyInstaller)
|
||||
# Download from https://rubyinstaller.org/
|
||||
gem install jekyll bundler
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Create New Site
|
||||
|
||||
```bash
|
||||
# Create new Jekyll site
|
||||
jekyll new myblog
|
||||
|
||||
# Navigate to site
|
||||
cd myblog
|
||||
|
||||
# Build and serve
|
||||
bundle exec jekyll serve
|
||||
|
||||
# Open http://localhost:4000
|
||||
```
|
||||
|
||||
### Directory Structure
|
||||
|
||||
```
|
||||
myblog/
|
||||
├── _config.yml # Site configuration
|
||||
├── _posts/ # Blog posts
|
||||
│ └── 2025-01-28-welcome.md
|
||||
├── _layouts/ # Page templates
|
||||
├── _includes/ # Reusable components
|
||||
├── _data/ # Data files (YAML, JSON, CSV)
|
||||
├── _sass/ # Sass partials
|
||||
├── assets/ # CSS, JS, images
|
||||
├── index.md # Home page
|
||||
└── Gemfile # Ruby dependencies
|
||||
```
|
||||
|
||||
## CLI Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `jekyll new <name>` | Create new site |
|
||||
| `jekyll build` | Build to `_site/` |
|
||||
| `jekyll serve` | Build and serve locally |
|
||||
| `jekyll clean` | Remove generated files |
|
||||
| `jekyll doctor` | Check for issues |
|
||||
|
||||
### Build Options
|
||||
|
||||
```bash
|
||||
# Build site
|
||||
bundle exec jekyll build
|
||||
|
||||
# Build with production environment
|
||||
JEKYLL_ENV=production bundle exec jekyll build
|
||||
|
||||
# Build to custom directory
|
||||
bundle exec jekyll build --destination ./public
|
||||
|
||||
# Build with incremental regeneration
|
||||
bundle exec jekyll build --incremental
|
||||
```
|
||||
|
||||
### Serve Options
|
||||
|
||||
```bash
|
||||
# Serve with live reload
|
||||
bundle exec jekyll serve --livereload
|
||||
|
||||
# Include draft posts
|
||||
bundle exec jekyll serve --drafts
|
||||
|
||||
# Specify port
|
||||
bundle exec jekyll serve --port 8080
|
||||
|
||||
# Bind to all interfaces
|
||||
bundle exec jekyll serve --host 0.0.0.0
|
||||
```
|
||||
|
||||
## Configuration (_config.yml)
|
||||
|
||||
```yaml
|
||||
# Site settings
|
||||
title: My Blog
|
||||
description: A great blog
|
||||
baseurl: ""
|
||||
url: "https://example.com"
|
||||
|
||||
# Build settings
|
||||
markdown: kramdown
|
||||
theme: minima
|
||||
plugins:
|
||||
- jekyll-feed
|
||||
- jekyll-seo-tag
|
||||
|
||||
# Kramdown settings
|
||||
kramdown:
|
||||
input: GFM
|
||||
syntax_highlighter: rouge
|
||||
hard_wrap: false
|
||||
|
||||
# Collections
|
||||
collections:
|
||||
docs:
|
||||
output: true
|
||||
permalink: /docs/:name/
|
||||
|
||||
# Defaults
|
||||
defaults:
|
||||
- scope:
|
||||
path: ""
|
||||
type: "posts"
|
||||
values:
|
||||
layout: "post"
|
||||
|
||||
# Exclude from processing
|
||||
exclude:
|
||||
- Gemfile
|
||||
- Gemfile.lock
|
||||
- node_modules
|
||||
- vendor
|
||||
```
|
||||
|
||||
## Front Matter
|
||||
|
||||
Every content file needs YAML front matter:
|
||||
|
||||
```markdown
|
||||
---
|
||||
layout: post
|
||||
title: "My First Post"
|
||||
date: 2025-01-28 12:00:00 -0500
|
||||
categories: blog tutorial
|
||||
tags: [jekyll, markdown]
|
||||
author: John Doe
|
||||
excerpt: "A brief introduction..."
|
||||
published: true
|
||||
---
|
||||
|
||||
Your content here...
|
||||
```
|
||||
|
||||
## Markdown Processors
|
||||
|
||||
### Kramdown (Default)
|
||||
|
||||
```yaml
|
||||
# _config.yml
|
||||
markdown: kramdown
|
||||
kramdown:
|
||||
input: GFM # GitHub Flavored Markdown
|
||||
syntax_highlighter: rouge
|
||||
syntax_highlighter_opts:
|
||||
block:
|
||||
line_numbers: true
|
||||
```
|
||||
|
||||
### CommonMark
|
||||
|
||||
```ruby
|
||||
# Gemfile
|
||||
gem 'jekyll-commonmark-ghpages'
|
||||
```
|
||||
|
||||
```yaml
|
||||
# _config.yml
|
||||
markdown: CommonMarkGhPages
|
||||
commonmark:
|
||||
options: ["SMART", "FOOTNOTES"]
|
||||
extensions: ["strikethrough", "autolink", "table"]
|
||||
```
|
||||
|
||||
## Liquid Templating
|
||||
|
||||
### Variables
|
||||
|
||||
```liquid
|
||||
{{ page.title }}
|
||||
{{ site.title }}
|
||||
{{ content }}
|
||||
{{ page.date | date: "%B %d, %Y" }}
|
||||
```
|
||||
|
||||
### Loops
|
||||
|
||||
```liquid
|
||||
{% for post in site.posts %}
|
||||
<article>
|
||||
<h2><a href="{{ post.url }}">{{ post.title }}</a></h2>
|
||||
<p>{{ post.excerpt }}</p>
|
||||
</article>
|
||||
{% endfor %}
|
||||
```
|
||||
|
||||
### Conditionals
|
||||
|
||||
```liquid
|
||||
{% if page.title %}
|
||||
<h1>{{ page.title }}</h1>
|
||||
{% endif %}
|
||||
|
||||
{% unless page.draft %}
|
||||
{{ content }}
|
||||
{% endunless %}
|
||||
```
|
||||
|
||||
### Includes
|
||||
|
||||
```liquid
|
||||
{% include header.html %}
|
||||
{% include footer.html param="value" %}
|
||||
```
|
||||
|
||||
## Layouts
|
||||
|
||||
### Basic Layout (_layouts/default.html)
|
||||
|
||||
```html
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>{{ page.title }} | {{ site.title }}</title>
|
||||
<link rel="stylesheet" href="{{ '/assets/css/style.css' | relative_url }}">
|
||||
</head>
|
||||
<body>
|
||||
{% include header.html %}
|
||||
<main>
|
||||
{{ content }}
|
||||
</main>
|
||||
{% include footer.html %}
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
### Post Layout (_layouts/post.html)
|
||||
|
||||
```html
|
||||
---
|
||||
layout: default
|
||||
---
|
||||
<article>
|
||||
<h1>{{ page.title }}</h1>
|
||||
<time>{{ page.date | date: "%B %d, %Y" }}</time>
|
||||
{{ content }}
|
||||
</article>
|
||||
```
|
||||
|
||||
## Plugins
|
||||
|
||||
### Common Plugins
|
||||
|
||||
```ruby
|
||||
# Gemfile
|
||||
group :jekyll_plugins do
|
||||
gem 'jekyll-feed' # RSS feed
|
||||
gem 'jekyll-seo-tag' # SEO meta tags
|
||||
gem 'jekyll-sitemap' # XML sitemap
|
||||
gem 'jekyll-paginate' # Pagination
|
||||
gem 'jekyll-archives' # Archive pages
|
||||
end
|
||||
```
|
||||
|
||||
### Using Plugins
|
||||
|
||||
```yaml
|
||||
# _config.yml
|
||||
plugins:
|
||||
- jekyll-feed
|
||||
- jekyll-seo-tag
|
||||
- jekyll-sitemap
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
| Issue | Solution |
|
||||
|-------|----------|
|
||||
| Ruby 3.0+ webrick error | `bundle add webrick` |
|
||||
| Permission denied | Use `--user-install` or rbenv |
|
||||
| Slow builds | Use `--incremental` |
|
||||
| Liquid errors | Check for unescaped `{` `}` |
|
||||
| Encoding issues | Add `encoding: utf-8` to config |
|
||||
| Plugin not loading | Add to both Gemfile and _config.yml |
|
||||
|
||||
## Resources
|
||||
|
||||
- [Jekyll Documentation](https://jekyllrb.com/docs/)
|
||||
- [Liquid Template Language](https://shopify.github.io/liquid/)
|
||||
- [Kramdown Documentation](https://kramdown.gettalong.org/)
|
||||
- [GitHub Repository](https://github.com/jekyll/jekyll)
|
||||
- [Jekyll Themes](https://jekyllthemes.io/)
|
||||
121
skills/markdown-to-html/references/marked.md
Normal file
121
skills/markdown-to-html/references/marked.md
Normal file
@@ -0,0 +1,121 @@
|
||||
# Marked
|
||||
|
||||
## Quick Conversion Methods
|
||||
|
||||
Expanded portions of `SKILL.md` at `### Quick Conversion Methods`.
|
||||
|
||||
### Method 1: CLI (Recommended for Single Files)
|
||||
|
||||
```bash
|
||||
# Convert file to HTML
|
||||
marked -i input.md -o output.html
|
||||
|
||||
# Convert string directly
|
||||
marked -s "# Hello World"
|
||||
|
||||
# Output: <h1>Hello World</h1>
|
||||
```
|
||||
|
||||
### Method 2: Node.js Script
|
||||
|
||||
```javascript
|
||||
import { marked } from 'marked';
|
||||
import { readFileSync, writeFileSync } from 'fs';
|
||||
|
||||
const markdown = readFileSync('input.md', 'utf-8');
|
||||
const html = marked.parse(markdown);
|
||||
writeFileSync('output.html', html);
|
||||
```
|
||||
|
||||
### Method 3: Browser Usage
|
||||
|
||||
```html
|
||||
<script src="https://cdn.jsdelivr.net/npm/marked/lib/marked.umd.js"></script>
|
||||
<script>
|
||||
const html = marked.parse('# Markdown Content');
|
||||
document.getElementById('output').innerHTML = html;
|
||||
</script>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Step-by-Step Workflows
|
||||
|
||||
Expanded portions of `SKILL.md` at `### Step-by-Step Workflows`.
|
||||
|
||||
### Workflow 1: Single File Conversion
|
||||
|
||||
1. Ensure marked is installed: `npm install -g marked`
|
||||
2. Run conversion: `marked -i README.md -o README.html`
|
||||
3. Verify output file was created
|
||||
|
||||
### Workflow 2: Batch Conversion (Multiple Files)
|
||||
|
||||
Create a script `convert-all.js`:
|
||||
|
||||
```javascript
|
||||
import { marked } from 'marked';
|
||||
import { readFileSync, writeFileSync, readdirSync } from 'fs';
|
||||
import { join, basename } from 'path';
|
||||
|
||||
const inputDir = './docs';
|
||||
const outputDir = './html';
|
||||
|
||||
readdirSync(inputDir)
|
||||
.filter(file => file.endsWith('.md'))
|
||||
.forEach(file => {
|
||||
const markdown = readFileSync(join(inputDir, file), 'utf-8');
|
||||
const html = marked.parse(markdown);
|
||||
const outputFile = basename(file, '.md') + '.html';
|
||||
writeFileSync(join(outputDir, outputFile), html);
|
||||
console.log(`Converted: ${file} → ${outputFile}`);
|
||||
});
|
||||
```
|
||||
|
||||
Run with: `node convert-all.js`
|
||||
|
||||
### Workflow 3: Conversion with Custom Options
|
||||
|
||||
```javascript
|
||||
import { marked } from 'marked';
|
||||
|
||||
// Configure options
|
||||
marked.setOptions({
|
||||
gfm: true, // GitHub Flavored Markdown
|
||||
breaks: true, // Convert \n to <br>
|
||||
pedantic: false, // Don't conform to original markdown.pl
|
||||
});
|
||||
|
||||
const html = marked.parse(markdownContent);
|
||||
```
|
||||
|
||||
### Workflow 4: Complete HTML Document
|
||||
|
||||
Wrap converted content in a full HTML template:
|
||||
|
||||
```javascript
|
||||
import { marked } from 'marked';
|
||||
import { readFileSync, writeFileSync } from 'fs';
|
||||
|
||||
const markdown = readFileSync('input.md', 'utf-8');
|
||||
const content = marked.parse(markdown);
|
||||
|
||||
const html = `<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Document</title>
|
||||
<style>
|
||||
body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', sans-serif; max-width: 800px; margin: 0 auto; padding: 2rem; }
|
||||
pre { background: #f4f4f4; padding: 1rem; overflow-x: auto; }
|
||||
code { background: #f4f4f4; padding: 0.2rem 0.4rem; border-radius: 3px; }
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
${content}
|
||||
</body>
|
||||
</html>`;
|
||||
|
||||
writeFileSync('output.html', html);
|
||||
```
|
||||
226
skills/markdown-to-html/references/pandoc.md
Normal file
226
skills/markdown-to-html/references/pandoc.md
Normal file
@@ -0,0 +1,226 @@
|
||||
# Pandoc Reference
|
||||
|
||||
Pandoc is a universal document converter that can convert between numerous markup formats, including Markdown, HTML, LaTeX, Word, and many more.
|
||||
|
||||
## Installation
|
||||
|
||||
### Windows
|
||||
|
||||
```powershell
|
||||
# Using Chocolatey
|
||||
choco install pandoc
|
||||
|
||||
# Using Scoop
|
||||
scoop install pandoc
|
||||
|
||||
# Or download installer from https://pandoc.org/installing.html
|
||||
```
|
||||
|
||||
### macOS
|
||||
|
||||
```bash
|
||||
# Using Homebrew
|
||||
brew install pandoc
|
||||
```
|
||||
|
||||
### Linux
|
||||
|
||||
```bash
|
||||
# Debian/Ubuntu
|
||||
sudo apt-get install pandoc
|
||||
|
||||
# Fedora
|
||||
sudo dnf install pandoc
|
||||
|
||||
# Or download from https://pandoc.org/installing.html
|
||||
```
|
||||
|
||||
## Basic Usage
|
||||
|
||||
### Convert Markdown to HTML
|
||||
|
||||
```bash
|
||||
# Basic conversion
|
||||
pandoc input.md -o output.html
|
||||
|
||||
# Standalone document with headers
|
||||
pandoc input.md -s -o output.html
|
||||
|
||||
# With custom CSS
|
||||
pandoc input.md -s --css=style.css -o output.html
|
||||
```
|
||||
|
||||
### Convert to Other Formats
|
||||
|
||||
```bash
|
||||
# To PDF (requires LaTeX)
|
||||
pandoc input.md -s -o output.pdf
|
||||
|
||||
# To Word
|
||||
pandoc input.md -s -o output.docx
|
||||
|
||||
# To LaTeX
|
||||
pandoc input.md -s -o output.tex
|
||||
|
||||
# To EPUB
|
||||
pandoc input.md -s -o output.epub
|
||||
```
|
||||
|
||||
### Convert from Other Formats
|
||||
|
||||
```bash
|
||||
# HTML to Markdown
|
||||
pandoc -f html -t markdown input.html -o output.md
|
||||
|
||||
# Word to Markdown
|
||||
pandoc input.docx -o output.md
|
||||
|
||||
# LaTeX to HTML
|
||||
pandoc -f latex -t html input.tex -o output.html
|
||||
```
|
||||
|
||||
## Common Options
|
||||
|
||||
| Option | Description |
|
||||
|--------|-------------|
|
||||
| `-f, --from <format>` | Input format |
|
||||
| `-t, --to <format>` | Output format |
|
||||
| `-s, --standalone` | Produce standalone document |
|
||||
| `-o, --output <file>` | Output file |
|
||||
| `--toc` | Include table of contents |
|
||||
| `--toc-depth <n>` | TOC depth (default: 3) |
|
||||
| `-N, --number-sections` | Number section headings |
|
||||
| `--css <url>` | Link to CSS stylesheet |
|
||||
| `--template <file>` | Use custom template |
|
||||
| `--metadata <key>=<value>` | Set metadata |
|
||||
| `--mathml` | Use MathML for math |
|
||||
| `--mathjax` | Use MathJax for math |
|
||||
| `-V, --variable <key>=<value>` | Set template variable |
|
||||
|
||||
## Markdown Extensions
|
||||
|
||||
Pandoc supports many markdown extensions:
|
||||
|
||||
```bash
|
||||
# Enable specific extensions
|
||||
pandoc -f markdown+emoji+footnotes input.md -o output.html
|
||||
|
||||
# Disable specific extensions
|
||||
pandoc -f markdown-pipe_tables input.md -o output.html
|
||||
|
||||
# Use strict markdown
|
||||
pandoc -f markdown_strict input.md -o output.html
|
||||
```
|
||||
|
||||
### Common Extensions
|
||||
|
||||
| Extension | Description |
|
||||
|-----------|-------------|
|
||||
| `pipe_tables` | Pipe tables (default on) |
|
||||
| `footnotes` | Footnote support |
|
||||
| `emoji` | Emoji shortcodes |
|
||||
| `smart` | Smart quotes and dashes |
|
||||
| `task_lists` | Task list checkboxes |
|
||||
| `strikeout` | Strikethrough text |
|
||||
| `superscript` | Superscript text |
|
||||
| `subscript` | Subscript text |
|
||||
| `raw_html` | Raw HTML passthrough |
|
||||
|
||||
## Templates
|
||||
|
||||
### Using Built-in Templates
|
||||
|
||||
```bash
|
||||
# View default template
|
||||
pandoc -D html
|
||||
|
||||
# Use custom template
|
||||
pandoc --template=mytemplate.html input.md -o output.html
|
||||
```
|
||||
|
||||
### Template Variables
|
||||
|
||||
```html
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>$title$</title>
|
||||
$for(css)$
|
||||
<link rel="stylesheet" href="$css$">
|
||||
$endfor$
|
||||
</head>
|
||||
<body>
|
||||
$body$
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
## YAML Metadata
|
||||
|
||||
Include metadata in your markdown files:
|
||||
|
||||
```markdown
|
||||
---
|
||||
title: My Document
|
||||
author: John Doe
|
||||
date: 2025-01-28
|
||||
abstract: |
|
||||
This is the abstract.
|
||||
---
|
||||
|
||||
# Introduction
|
||||
|
||||
Document content here...
|
||||
```
|
||||
|
||||
## Filters
|
||||
|
||||
### Using Lua Filters
|
||||
|
||||
```bash
|
||||
pandoc --lua-filter=filter.lua input.md -o output.html
|
||||
```
|
||||
|
||||
Example Lua filter (`filter.lua`):
|
||||
|
||||
```lua
|
||||
function Header(el)
|
||||
if el.level == 1 then
|
||||
el.classes:insert("main-title")
|
||||
end
|
||||
return el
|
||||
end
|
||||
```
|
||||
|
||||
### Using Pandoc Filters
|
||||
|
||||
```bash
|
||||
pandoc --filter pandoc-citeproc input.md -o output.html
|
||||
```
|
||||
|
||||
## Batch Conversion
|
||||
|
||||
### Bash Script
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
for file in *.md; do
|
||||
pandoc "$file" -s -o "${file%.md}.html"
|
||||
done
|
||||
```
|
||||
|
||||
### PowerShell Script
|
||||
|
||||
```powershell
|
||||
Get-ChildItem -Filter *.md | ForEach-Object {
|
||||
$output = $_.BaseName + ".html"
|
||||
pandoc $_.Name -s -o $output
|
||||
}
|
||||
```
|
||||
|
||||
## Resources
|
||||
|
||||
- [Pandoc User's Guide](https://pandoc.org/MANUAL.html)
|
||||
- [Pandoc Demos](https://pandoc.org/demos.html)
|
||||
- [Pandoc FAQ](https://pandoc.org/faqs.html)
|
||||
- [GitHub Repository](https://github.com/jgm/pandoc)
|
||||
169
skills/markdown-to-html/references/tables-to-html.md
Normal file
169
skills/markdown-to-html/references/tables-to-html.md
Normal file
@@ -0,0 +1,169 @@
|
||||
# Tables to HTML
|
||||
|
||||
## Creating a table
|
||||
|
||||
### Markdown
|
||||
|
||||
```markdown
|
||||
|
||||
| First Header | Second Header |
|
||||
| ------------- | ------------- |
|
||||
| Content Cell | Content Cell |
|
||||
| Content Cell | Content Cell |
|
||||
```
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>First Header</th>
|
||||
<th>Second Header</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Content Cell</td>
|
||||
<td>Content Cell</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Content Cell</td>
|
||||
<td>Content Cell</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
```
|
||||
|
||||
### Markdown
|
||||
|
||||
```markdown
|
||||
| Command | Description |
|
||||
| --- | --- |
|
||||
| git status | List all new or modified files |
|
||||
| git diff | Show file differences that haven't been staged |
|
||||
```
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Command</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>git status</td>
|
||||
<td>List all new or modified files</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>git diff</td>
|
||||
<td>Show file differences that haven't been staged</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
```
|
||||
|
||||
## Formatting Content in Tables
|
||||
|
||||
### Markdown
|
||||
|
||||
```markdown
|
||||
| Command | Description |
|
||||
| --- | --- |
|
||||
| `git status` | List all *new or modified* files |
|
||||
| `git diff` | Show file differences that **haven't been** staged |
|
||||
```
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Command</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>git status</code></td>
|
||||
<td>List all <em>new or modified</em> files</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>git diff</code></td>
|
||||
<td>Show file differences that <strong>haven't been</strong> staged</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
```
|
||||
|
||||
### Markdown
|
||||
|
||||
```markdown
|
||||
| Left-aligned | Center-aligned | Right-aligned |
|
||||
| :--- | :---: | ---: |
|
||||
| git status | git status | git status |
|
||||
| git diff | git diff | git diff |
|
||||
```
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Left-aligned</th>
|
||||
<th align="center">Center-aligned</th>
|
||||
<th align="right">Right-aligned</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left">git status</td>
|
||||
<td align="center">git status</td>
|
||||
<td align="right">git status</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left">git diff</td>
|
||||
<td align="center">git diff</td>
|
||||
<td align="right">git diff</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
```
|
||||
|
||||
### Markdown
|
||||
|
||||
```markdown
|
||||
| Name | Character |
|
||||
| --- | --- |
|
||||
| Backtick | ` |
|
||||
| Pipe | \| |
|
||||
```
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Character</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Backtick</td>
|
||||
<td>`</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Pipe</td>
|
||||
<td>|</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
```
|
||||
72
skills/markdown-to-html/references/tables.md
Normal file
72
skills/markdown-to-html/references/tables.md
Normal file
@@ -0,0 +1,72 @@
|
||||
# Organizing information with tables
|
||||
|
||||
You can build tables to organize information in comments, issues, pull requests, and wikis.
|
||||
|
||||
## Creating a table
|
||||
|
||||
You can create tables with pipes `|` and hyphens `-`. Hyphens are used to create each column's header, while pipes separate each column. You must include a blank line before your table in order for it to correctly render.
|
||||
|
||||
```markdown
|
||||
|
||||
| First Header | Second Header |
|
||||
| ------------- | ------------- |
|
||||
| Content Cell | Content Cell |
|
||||
| Content Cell | Content Cell |
|
||||
```
|
||||
|
||||
|
||||
|
||||
The pipes on either end of the table are optional.
|
||||
|
||||
Cells can vary in width and do not need to be perfectly aligned within columns. There must be at least three hyphens in each column of the header row.
|
||||
|
||||
```markdown
|
||||
| Command | Description |
|
||||
| --- | --- |
|
||||
| git status | List all new or modified files |
|
||||
| git diff | Show file differences that haven't been staged |
|
||||
```
|
||||
|
||||
|
||||
|
||||
If you are frequently editing code snippets and tables, you may benefit from enabling a fixed-width font in all comment fields on GitHub. For more information, see [About writing and formatting on GitHub](https://docs.github.com/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github#enabling-fixed-width-fonts-in-the-editor).
|
||||
|
||||
## Formatting content within your table
|
||||
|
||||
You can use [formatting](https://docs.github.com/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) such as links, inline code blocks, and text styling within your table:
|
||||
|
||||
```markdown
|
||||
| Command | Description |
|
||||
| --- | --- |
|
||||
| `git status` | List all *new or modified* files |
|
||||
| `git diff` | Show file differences that **haven't been** staged |
|
||||
```
|
||||
|
||||
|
||||
|
||||
You can align text to the left, right, or center of a column by including colons `:` to the left, right, or on both sides of the hyphens within the header row.
|
||||
|
||||
```markdown
|
||||
| Left-aligned | Center-aligned | Right-aligned |
|
||||
| :--- | :---: | ---: |
|
||||
| git status | git status | git status |
|
||||
| git diff | git diff | git diff |
|
||||
```
|
||||
|
||||
|
||||
|
||||
To include a pipe `|` as content within your cell, use a `\` before the pipe:
|
||||
|
||||
```markdown
|
||||
| Name | Character |
|
||||
| --- | --- |
|
||||
| Backtick | ` |
|
||||
| Pipe | \| |
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Further reading
|
||||
|
||||
* [GitHub Flavored Markdown Spec](https://github.github.com/gfm/)
|
||||
* [Basic writing and formatting syntax](https://docs.github.com/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
|
||||
@@ -0,0 +1,350 @@
|
||||
# Writing Mathematical Expressions to HTML
|
||||
|
||||
## Writing Inline Expressions
|
||||
|
||||
### Markdown
|
||||
|
||||
```markdown
|
||||
This sentence uses `$` delimiters to show math inline: $\sqrt{3x-1}+(1+x)^2$
|
||||
```
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<p>This sentence uses <code>$</code> delimiters to show math inline:
|
||||
<math-renderer><math xmlns="http://www.w3.org/1998/Math/MathML">
|
||||
<msqrt>
|
||||
<mn>3</mn>
|
||||
<mi>x</mi>
|
||||
<mo>−</mo>
|
||||
<mn>1</mn>
|
||||
</msqrt>
|
||||
<mo>+</mo>
|
||||
<mo>(</mo>
|
||||
<mn>1</mn>
|
||||
<mo>+</mo>
|
||||
<mi>x</mi>
|
||||
<msup>
|
||||
<mo>)</mo>
|
||||
<mn>2</mn>
|
||||
</msup>
|
||||
</math>
|
||||
</math-renderer>
|
||||
</p>
|
||||
```
|
||||
|
||||
### Markdown
|
||||
|
||||
```markdown
|
||||
This sentence uses $\` and \`$ delimiters to show math inline: $`\sqrt{3x-1}+(1+x)^2`$
|
||||
```
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<p>This sentence uses
|
||||
<math-renderer>
|
||||
<math xmlns="http://www.w3.org/1998/Math/MathML">
|
||||
<mo>‘</mo>
|
||||
<mi>a</mi>
|
||||
<mi>n</mi>
|
||||
<mi>d</mi>
|
||||
<mo>‘</mo>
|
||||
</math>
|
||||
</math-renderer> delimiters to show math inline:
|
||||
<math-renderer>
|
||||
<math xmlns="http://www.w3.org/1998/Math/MathML">
|
||||
<msqrt>
|
||||
<mn>3</mn>
|
||||
<mi>x</mi>
|
||||
<mo>−</mo>
|
||||
<mn>1</mn>
|
||||
</msqrt>
|
||||
<mo>+</mo>
|
||||
<mo stretchy="false">(</mo>
|
||||
<mn>1</mn>
|
||||
<mo>+</mo>
|
||||
<mi>x</mi>
|
||||
<msup>
|
||||
<mo stretchy="false">)</mo>
|
||||
<mn>2</mn>
|
||||
</msup>
|
||||
</math>
|
||||
</math-renderer>
|
||||
</p>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Writing Expressions as Blocks
|
||||
|
||||
### Markdown
|
||||
|
||||
```markdown
|
||||
**The Cauchy-Schwarz Inequality**\
|
||||
$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
|
||||
```
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<p>
|
||||
<strong>The Cauchy-Schwarz Inequality</strong><br>
|
||||
<math-renderer>
|
||||
<math xmlns="http://www.w3.org/1998/Math/MathML">
|
||||
<msup>
|
||||
<mrow>
|
||||
<mo>(</mo>
|
||||
<munderover>
|
||||
<mo>∑</mo>
|
||||
<mrow>
|
||||
<mi>k</mi>
|
||||
<mo>=</mo>
|
||||
<mn>1</mn>
|
||||
</mrow>
|
||||
<mi>n</mi>
|
||||
</munderover>
|
||||
<msub>
|
||||
<mi>a</mi>
|
||||
<mi>k</mi>
|
||||
</msub>
|
||||
<msub>
|
||||
<mi>b</mi>
|
||||
<mi>k</mi>
|
||||
</msub>
|
||||
<mo>)</mo>
|
||||
</mrow>
|
||||
<mn>2</mn>
|
||||
</msup>
|
||||
<mo>≤</mo>
|
||||
<mrow>
|
||||
<mo>(</mo>
|
||||
<munderover>
|
||||
<mo>∑</mo>
|
||||
<mrow>
|
||||
<mi>k</mi>
|
||||
<mo>=</mo>
|
||||
<mn>1</mn>
|
||||
</mrow>
|
||||
<mi>n</mi>
|
||||
</munderover>
|
||||
<msubsup>
|
||||
<mi>a</mi>
|
||||
<mi>k</mi>
|
||||
<mn>2</mn>
|
||||
</msubsup>
|
||||
<mo>)</mo>
|
||||
</mrow>
|
||||
<mrow>
|
||||
<mo>(</mo>
|
||||
<munderover>
|
||||
<mo>∑</mo>
|
||||
<mrow>
|
||||
<mi>k</mi>
|
||||
<mo>=</mo>
|
||||
<mn>1</mn>
|
||||
</mrow>
|
||||
<mi>n</mi>
|
||||
</munderover>
|
||||
<msubsup>
|
||||
<mi>b</mi>
|
||||
<mi>k</mi>
|
||||
<mn>2</mn>
|
||||
</msubsup>
|
||||
<mo>)</mo>
|
||||
</mrow>
|
||||
</math>
|
||||
</math-renderer>
|
||||
</p>
|
||||
```
|
||||
|
||||
### Markdown
|
||||
|
||||
```markdown
|
||||
**The Cauchy-Schwarz Inequality**
|
||||
|
||||
```math
|
||||
\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)
|
||||
```
|
||||
```
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<p><strong>The Cauchy-Schwarz Inequality</strong></p>
|
||||
|
||||
<math-renderer>
|
||||
<math xmlns="http://www.w3.org/1998/Math/MathML">
|
||||
<msup>
|
||||
<mrow>
|
||||
<mo>(</mo>
|
||||
<munderover>
|
||||
<mo>∑</mo>
|
||||
<mrow>
|
||||
<mi>k</mi>
|
||||
<mo>=</mo>
|
||||
<mn>1</mn>
|
||||
</mrow>
|
||||
<mi>n</mi>
|
||||
</munderover>
|
||||
<msub>
|
||||
<mi>a</mi>
|
||||
<mi>k</mi>
|
||||
</msub>
|
||||
<msub>
|
||||
<mi>b</mi>
|
||||
<mi>k</mi>
|
||||
</msub>
|
||||
<mo>)</mo>
|
||||
</mrow>
|
||||
<mn>2</mn>
|
||||
</msup>
|
||||
<mo>≤</mo>
|
||||
<mrow>
|
||||
<mo>(</mo>
|
||||
<munderover>
|
||||
<mo>∑</mo>
|
||||
<mrow>
|
||||
<mi>k</mi>
|
||||
<mo>=</mo>
|
||||
<mn>1</mn>
|
||||
</mrow>
|
||||
<mi>n</mi>
|
||||
</munderover>
|
||||
<msubsup>
|
||||
<mi>a</mi>
|
||||
<mi>k</mi>
|
||||
<mn>2</mn>
|
||||
</msubsup>
|
||||
<mo>)</mo>
|
||||
</mrow>
|
||||
<mrow>
|
||||
<mo>(</mo>
|
||||
<munderover>
|
||||
<mo>∑</mo>
|
||||
<mrow>
|
||||
<mi>k</mi>
|
||||
<mo>=</mo>
|
||||
<mn>1</mn>
|
||||
</mrow>
|
||||
<mi>n</mi>
|
||||
</munderover>
|
||||
<msubsup>
|
||||
<mi>b</mi>
|
||||
<mi>k</mi>
|
||||
<mn>2</mn>
|
||||
</msubsup>
|
||||
<mo>)</mo>
|
||||
</mrow>
|
||||
</math>
|
||||
</math-renderer>
|
||||
```
|
||||
|
||||
### Markdown
|
||||
|
||||
```markdown
|
||||
The equation $a^2 + b^2 = c^2$ is the Pythagorean theorem.
|
||||
```
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<p>The equation
|
||||
<math-renderer><math xmlns="http://www.w3.org/1998/Math/MathML">
|
||||
<msup>
|
||||
<mi>a</mi>
|
||||
<mn>2</mn>
|
||||
</msup>
|
||||
<mo>+</mo>
|
||||
<msup>
|
||||
<mi>b</mi>
|
||||
<mn>2</mn>
|
||||
</msup>
|
||||
<mo>=</mo>
|
||||
<msup>
|
||||
<mi>c</mi>
|
||||
<mn>2</mn>
|
||||
</msup>
|
||||
</math></math-renderer> is the Pythagorean theorem.
|
||||
</p>
|
||||
```
|
||||
|
||||
### Markdown
|
||||
|
||||
```
|
||||
$$
|
||||
\int_0^\infty e^{-x} dx = 1
|
||||
$$
|
||||
```
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<p><math-renderer><math xmlns="http://www.w3.org/1998/Math/MathML">
|
||||
<msubsup>
|
||||
<mo>∫</mo>
|
||||
<mn>0</mn>
|
||||
<mi>∞</mi>
|
||||
</msubsup>
|
||||
<msup>
|
||||
<mi>e</mi>
|
||||
<mrow>
|
||||
<mo>−</mo>
|
||||
<mi>x</mi>
|
||||
</mrow>
|
||||
</msup>
|
||||
<mi>d</mi>
|
||||
<mi>x</mi>
|
||||
<mo>=</mo>
|
||||
<mn>1</mn>
|
||||
</math></math-renderer></p>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Dollar Sign Inline with Mathematical Expression
|
||||
|
||||
### Markdown
|
||||
|
||||
```markdown
|
||||
This expression uses `\$` to display a dollar sign: $`\sqrt{\$4}`$
|
||||
```
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<p>This expression uses
|
||||
<code>\$</code> to display a dollar sign:
|
||||
<math-renderer>
|
||||
<math xmlns="http://www.w3.org/1998/Math/MathML">
|
||||
<msqrt>
|
||||
<mi>$</mi>
|
||||
<mn>4</mn>
|
||||
</msqrt>
|
||||
</math>
|
||||
</math-renderer>
|
||||
</p>
|
||||
```
|
||||
|
||||
### Markdown
|
||||
|
||||
```markdown
|
||||
To split <span>$</span>100 in half, we calculate $100/2$
|
||||
```
|
||||
|
||||
### Parsed HTML
|
||||
|
||||
```html
|
||||
<p>To split
|
||||
<span>$</span>100 in half, we calculate
|
||||
<math-renderer>
|
||||
<math xmlns="http://www.w3.org/1998/Math/MathML">
|
||||
<mn>100</mn>
|
||||
<mrow data-mjx-texclass="ORD">
|
||||
<mo>/</mo>
|
||||
</mrow>
|
||||
<mn>2</mn>
|
||||
</math>
|
||||
</math-renderer>
|
||||
</p>
|
||||
```
|
||||
@@ -0,0 +1,76 @@
|
||||
# Writing mathematical expressions
|
||||
|
||||
Use Markdown to display mathematical expressions on GitHub.
|
||||
|
||||
## About writing mathematical expressions
|
||||
|
||||
To enable clear communication of mathematical expressions, GitHub supports LaTeX formatted math within Markdown. For more information, see [LaTeX/Mathematics](http://en.wikibooks.org/wiki/LaTeX/Mathematics) in Wikibooks.
|
||||
|
||||
GitHub's math rendering capability uses MathJax; an open source, JavaScript-based display engine. MathJax supports a wide range of LaTeX macros, and several useful accessibility extensions. For more information, see [the MathJax documentation](http://docs.mathjax.org/en/latest/input/tex/index.html#tex-and-latex-support) and [the MathJax Accessibility Extensions Documentation](https://mathjax.github.io/MathJax-a11y/docs/#reader-guide).
|
||||
|
||||
Mathematical expressions rendering is available in GitHub Issues, GitHub Discussions, pull requests, wikis, and Markdown files.
|
||||
|
||||
## Writing inline expressions
|
||||
|
||||
There are two options for delimiting a math expression inline with your text. You can either surround the expression with dollar symbols (`$`), or start the expression with <code>$\`</code> and end it with <code>\`$</code>. The latter syntax is useful when the expression you are writing contains characters that overlap with markdown syntax. For more information, see [Basic writing and formatting syntax](https://docs.github.com/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).
|
||||
|
||||
```text
|
||||
This sentence uses `$` delimiters to show math inline: $\sqrt{3x-1}+(1+x)^2$
|
||||
```
|
||||
|
||||
|
||||
|
||||
```text
|
||||
This sentence uses $\` and \`$ delimiters to show math inline: $`\sqrt{3x-1}+(1+x)^2`$
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Writing expressions as blocks
|
||||
|
||||
To add a math expression as a block, start a new line and delimit the expression with two dollar symbols `$$`.
|
||||
|
||||
> [!TIP] If you're writing in an .md file, you will need to use specific formatting to create a line break, such as ending the line with a backslash as shown in the example below. For more information on line breaks in Markdown, see [Basic writing and formatting syntax](https://docs.github.com/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#line-breaks).
|
||||
|
||||
```text
|
||||
**The Cauchy-Schwarz Inequality**\
|
||||
$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
|
||||
```
|
||||
|
||||
|
||||
|
||||
Alternatively, you can use the <code>\`\`\`math</code> code block syntax to display a math expression as a block. With this syntax, you don't need to use `$$` delimiters. The following will render the same as above:
|
||||
|
||||
````text
|
||||
**The Cauchy-Schwarz Inequality**
|
||||
|
||||
```math
|
||||
\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)
|
||||
```
|
||||
````
|
||||
|
||||
## Writing dollar signs in line with and within mathematical expressions
|
||||
|
||||
To display a dollar sign as a character in the same line as a mathematical expression, you need to escape the non-delimiter `$` to ensure the line renders correctly.
|
||||
|
||||
* Within a math expression, add a `\` symbol before the explicit `$`.
|
||||
|
||||
```text
|
||||
This expression uses `\$` to display a dollar sign: $`\sqrt{\$4}`$
|
||||
```
|
||||
|
||||
|
||||
|
||||
* Outside a math expression, but on the same line, use span tags around the explicit `$`.
|
||||
|
||||
```text
|
||||
To split <span>$</span>100 in half, we calculate $100/2$
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Further reading
|
||||
|
||||
* [The MathJax website](http://mathjax.org)
|
||||
* [Getting started with writing and formatting on GitHub](https://docs.github.com/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github)
|
||||
* [GitHub Flavored Markdown Spec](https://github.github.com/gfm/)
|
||||
48
skills/terraform-azurerm-set-diff-analyzer/SKILL.md
Normal file
48
skills/terraform-azurerm-set-diff-analyzer/SKILL.md
Normal file
@@ -0,0 +1,48 @@
|
||||
---
|
||||
name: terraform-azurerm-set-diff-analyzer
|
||||
description: Analyze Terraform plan JSON output for AzureRM Provider to distinguish between false-positive diffs (order-only changes in Set-type attributes) and actual resource changes. Use when reviewing terraform plan output for Azure resources like Application Gateway, Load Balancer, Firewall, Front Door, NSG, and other resources with Set-type attributes that cause spurious diffs due to internal ordering changes.
|
||||
license: MIT
|
||||
---
|
||||
|
||||
# Terraform AzureRM Set Diff Analyzer
|
||||
|
||||
A skill to identify "false-positive diffs" in Terraform plans caused by AzureRM Provider's Set-type attributes and distinguish them from actual changes.
|
||||
|
||||
## When to Use
|
||||
|
||||
- `terraform plan` shows many changes, but you only added/removed a single element
|
||||
- Application Gateway, Load Balancer, NSG, etc. show "all elements changed"
|
||||
- You want to automatically filter false-positive diffs in CI/CD
|
||||
|
||||
## Background
|
||||
|
||||
Terraform's Set type compares by position rather than by key, so when adding or removing elements, all elements appear as "changed". This is a general Terraform issue, but it's particularly noticeable with AzureRM resources that heavily use Set-type attributes like Application Gateway, Load Balancer, and NSG.
|
||||
|
||||
These "false-positive diffs" don't actually affect the resources, but they make reviewing terraform plan output difficult.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Python 3.8+
|
||||
|
||||
If Python is unavailable, install via your package manager (e.g., `apt install python3`, `brew install python3`) or from [python.org](https://www.python.org/downloads/).
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```bash
|
||||
# 1. Generate plan JSON output
|
||||
terraform plan -out=plan.tfplan
|
||||
terraform show -json plan.tfplan > plan.json
|
||||
|
||||
# 2. Analyze
|
||||
python scripts/analyze_plan.py plan.json
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- **`python: command not found`**: Use `python3` instead, or install Python
|
||||
- **`ModuleNotFoundError`**: Script uses only standard library; ensure Python 3.8+
|
||||
|
||||
## Detailed Documentation
|
||||
|
||||
- [scripts/README.md](scripts/README.md) - All options, output formats, exit codes, CI/CD examples
|
||||
- [references/azurerm_set_attributes.md](references/azurerm_set_attributes.md) - Supported resources and attributes
|
||||
@@ -0,0 +1,154 @@
|
||||
{
|
||||
"metadata": {
|
||||
"description": "AzureRM Provider Set-type attribute definitions",
|
||||
"lastUpdated": "2026-01-28",
|
||||
"source": "Terraform Registry documentation and AzureRM Provider source code"
|
||||
},
|
||||
"resources": {
|
||||
"azurerm_application_gateway": {
|
||||
"backend_address_pool": "name",
|
||||
"backend_http_settings": "name",
|
||||
"custom_error_configuration": "status_code",
|
||||
"frontend_ip_configuration": "name",
|
||||
"frontend_port": "name",
|
||||
"gateway_ip_configuration": "name",
|
||||
"http_listener": "name",
|
||||
"probe": "name",
|
||||
"private_link_configuration": "name",
|
||||
"redirect_configuration": "name",
|
||||
"request_routing_rule": "name",
|
||||
"rewrite_rule_set": {
|
||||
"_key": "name",
|
||||
"rewrite_rule": {
|
||||
"_key": "name",
|
||||
"condition": "variable",
|
||||
"request_header_configuration": "header_name",
|
||||
"response_header_configuration": "header_name"
|
||||
}
|
||||
},
|
||||
"ssl_certificate": "name",
|
||||
"ssl_profile": "name",
|
||||
"trusted_client_certificate": "name",
|
||||
"trusted_root_certificate": "name",
|
||||
"url_path_map": {
|
||||
"_key": "name",
|
||||
"path_rule": {
|
||||
"_key": "name",
|
||||
"paths": null
|
||||
}
|
||||
}
|
||||
},
|
||||
"azurerm_lb": {
|
||||
"frontend_ip_configuration": "name"
|
||||
},
|
||||
"azurerm_lb_backend_address_pool": {
|
||||
"backend_address": "name"
|
||||
},
|
||||
"azurerm_lb_rule": {
|
||||
"backend_address_pool_ids": null
|
||||
},
|
||||
"azurerm_firewall": {
|
||||
"ip_configuration": "name",
|
||||
"management_ip_configuration": "name",
|
||||
"virtual_hub": null
|
||||
},
|
||||
"azurerm_firewall_policy_rule_collection_group": {
|
||||
"application_rule_collection": {
|
||||
"_key": "name",
|
||||
"rule": {
|
||||
"_key": "name",
|
||||
"protocols": null,
|
||||
"destination_fqdns": null
|
||||
}
|
||||
},
|
||||
"network_rule_collection": {
|
||||
"_key": "name",
|
||||
"rule": {
|
||||
"_key": "name",
|
||||
"destination_addresses": null,
|
||||
"destination_ports": null
|
||||
}
|
||||
},
|
||||
"nat_rule_collection": {
|
||||
"_key": "name",
|
||||
"rule": "name"
|
||||
}
|
||||
},
|
||||
"azurerm_frontdoor": {
|
||||
"backend_pool": {
|
||||
"_key": "name",
|
||||
"backend": "address"
|
||||
},
|
||||
"backend_pool_health_probe": "name",
|
||||
"backend_pool_load_balancing": "name",
|
||||
"frontend_endpoint": "name",
|
||||
"routing_rule": "name"
|
||||
},
|
||||
"azurerm_cdn_frontdoor_origin_group": {
|
||||
"health_probe": null,
|
||||
"load_balancing": null
|
||||
},
|
||||
"azurerm_network_security_group": {
|
||||
"security_rule": "name"
|
||||
},
|
||||
"azurerm_route_table": {
|
||||
"route": "name"
|
||||
},
|
||||
"azurerm_virtual_network": {
|
||||
"subnet": "name"
|
||||
},
|
||||
"azurerm_virtual_network_gateway": {
|
||||
"ip_configuration": "name",
|
||||
"vpn_client_configuration": {
|
||||
"_key": null,
|
||||
"root_certificate": "name",
|
||||
"revoked_certificate": "name",
|
||||
"radius_server": "address"
|
||||
},
|
||||
"policy_group": "name"
|
||||
},
|
||||
"azurerm_virtual_network_gateway_connection": {
|
||||
"ipsec_policy": null
|
||||
},
|
||||
"azurerm_nat_gateway": {
|
||||
"public_ip_address_ids": null,
|
||||
"public_ip_prefix_ids": null
|
||||
},
|
||||
"azurerm_private_endpoint": {
|
||||
"ip_configuration": "name",
|
||||
"private_dns_zone_group": "name",
|
||||
"private_service_connection": "name"
|
||||
},
|
||||
"azurerm_api_management": {
|
||||
"additional_location": "location",
|
||||
"certificate": "encoded_certificate",
|
||||
"hostname_configuration": {
|
||||
"_key": null,
|
||||
"management": "host_name",
|
||||
"portal": "host_name",
|
||||
"developer_portal": "host_name",
|
||||
"proxy": "host_name",
|
||||
"scm": "host_name"
|
||||
}
|
||||
},
|
||||
"azurerm_storage_account": {
|
||||
"network_rules": null,
|
||||
"blob_properties": null
|
||||
},
|
||||
"azurerm_key_vault": {
|
||||
"network_acls": null
|
||||
},
|
||||
"azurerm_cosmosdb_account": {
|
||||
"geo_location": "location",
|
||||
"capabilities": "name",
|
||||
"virtual_network_rule": "id"
|
||||
},
|
||||
"azurerm_kubernetes_cluster": {
|
||||
"default_node_pool": null
|
||||
},
|
||||
"azurerm_kubernetes_cluster_node_pool": {
|
||||
"node_labels": null,
|
||||
"node_taints": null
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,145 @@
|
||||
# AzureRM Set-Type Attributes Reference
|
||||
|
||||
This document explains the overview and maintenance of `azurerm_set_attributes.json`.
|
||||
|
||||
> **Last Updated**: January 28, 2026
|
||||
|
||||
## Overview
|
||||
|
||||
`azurerm_set_attributes.json` is a definition file for attributes treated as Set-type in the AzureRM Provider.
|
||||
The `analyze_plan.py` script reads this JSON to identify "false-positive diffs" in Terraform plans.
|
||||
|
||||
### What are Set-Type Attributes?
|
||||
|
||||
Terraform's Set type is a collection that **does not guarantee order**.
|
||||
Therefore, when adding or removing elements, unchanged elements may appear as "changed".
|
||||
This is called a "false-positive diff".
|
||||
|
||||
## JSON File Structure
|
||||
|
||||
### Basic Format
|
||||
|
||||
```json
|
||||
{
|
||||
"resources": {
|
||||
"azurerm_resource_type": {
|
||||
"attribute_name": "key_attribute"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- **key_attribute**: The attribute that uniquely identifies Set elements (e.g., `name`, `id`)
|
||||
- **null**: When there is no key attribute (compare entire element)
|
||||
|
||||
### Nested Format
|
||||
|
||||
When a Set attribute contains another Set attribute:
|
||||
|
||||
```json
|
||||
{
|
||||
"rewrite_rule_set": {
|
||||
"_key": "name",
|
||||
"rewrite_rule": {
|
||||
"_key": "name",
|
||||
"condition": "variable",
|
||||
"request_header_configuration": "header_name"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- **`_key`**: The key attribute for that level's Set elements
|
||||
- **Other keys**: Definitions for nested Set attributes
|
||||
|
||||
### Example: azurerm_application_gateway
|
||||
|
||||
```json
|
||||
"azurerm_application_gateway": {
|
||||
"backend_address_pool": "name", // Simple Set (key is name)
|
||||
"rewrite_rule_set": { // Nested Set
|
||||
"_key": "name",
|
||||
"rewrite_rule": {
|
||||
"_key": "name",
|
||||
"condition": "variable"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Maintenance
|
||||
|
||||
### Adding New Attributes
|
||||
|
||||
1. **Check Official Documentation**
|
||||
- Search for the resource in [Terraform Registry](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs)
|
||||
- Verify the attribute is listed as "Set of ..."
|
||||
- Some resources like `azurerm_application_gateway` have Set attributes noted explicitly
|
||||
|
||||
2. **Check Source Code (more reliable)**
|
||||
- Search for the resource in [AzureRM Provider GitHub](https://github.com/hashicorp/terraform-provider-azurerm)
|
||||
- Confirm `Type: pluginsdk.TypeSet` in the schema definition
|
||||
- Identify attributes within the Set's `Schema` that can serve as `_key`
|
||||
|
||||
3. **Add to JSON**
|
||||
```json
|
||||
"azurerm_new_resource": {
|
||||
"set_attribute": "key_attribute"
|
||||
}
|
||||
```
|
||||
|
||||
4. **Test**
|
||||
```bash
|
||||
# Verify with an actual plan
|
||||
python3 scripts/analyze_plan.py your_plan.json
|
||||
```
|
||||
|
||||
### Identifying Key Attributes
|
||||
|
||||
| Common Key Attribute | Usage |
|
||||
|---------------------|-------|
|
||||
| `name` | Named blocks (most common) |
|
||||
| `id` | Resource ID reference |
|
||||
| `location` | Geographic location |
|
||||
| `address` | Network address |
|
||||
| `host_name` | Hostname |
|
||||
| `null` | When no key exists (compare entire element) |
|
||||
|
||||
## Related Tools
|
||||
|
||||
### analyze_plan.py
|
||||
|
||||
Analyzes Terraform plan JSON to identify false-positive diffs.
|
||||
|
||||
```bash
|
||||
# Basic usage
|
||||
terraform show -json plan.tfplan | python3 scripts/analyze_plan.py
|
||||
|
||||
# Read from file
|
||||
python3 scripts/analyze_plan.py plan.json
|
||||
|
||||
# Use custom attribute file
|
||||
python3 scripts/analyze_plan.py plan.json --attributes /path/to/custom.json
|
||||
```
|
||||
|
||||
## Supported Resources
|
||||
|
||||
Please refer to `azurerm_set_attributes.json` directly for currently supported resources:
|
||||
|
||||
```bash
|
||||
# List resources
|
||||
jq '.resources | keys' azurerm_set_attributes.json
|
||||
```
|
||||
|
||||
Key resources:
|
||||
- `azurerm_application_gateway` - Backend pools, listeners, rules, etc.
|
||||
- `azurerm_firewall_policy_rule_collection_group` - Rule collections
|
||||
- `azurerm_frontdoor` - Backend pools, routing
|
||||
- `azurerm_network_security_group` - Security rules
|
||||
- `azurerm_virtual_network_gateway` - IP configuration, VPN client configuration
|
||||
|
||||
## Notes
|
||||
|
||||
- Attribute behavior may differ depending on Provider/API version
|
||||
- New resources and attributes need to be added as they become available
|
||||
- Defining all levels of deeply nested structures improves accuracy
|
||||
74
skills/terraform-azurerm-set-diff-analyzer/scripts/.gitignore
vendored
Normal file
74
skills/terraform-azurerm-set-diff-analyzer/scripts/.gitignore
vendored
Normal file
@@ -0,0 +1,74 @@
|
||||
# Byte-compiled / optimized / DLL files
|
||||
__pycache__/
|
||||
*.py[cod]
|
||||
*$py.class
|
||||
|
||||
# C extensions
|
||||
*.so
|
||||
|
||||
# Distribution / packaging
|
||||
.Python
|
||||
build/
|
||||
develop-eggs/
|
||||
dist/
|
||||
downloads/
|
||||
eggs/
|
||||
.eggs/
|
||||
lib/
|
||||
lib64/
|
||||
parts/
|
||||
sdist/
|
||||
var/
|
||||
wheels/
|
||||
*.egg-info/
|
||||
.installed.cfg
|
||||
*.egg
|
||||
|
||||
# PyInstaller
|
||||
*.manifest
|
||||
*.spec
|
||||
|
||||
# Installer logs
|
||||
pip-log.txt
|
||||
pip-delete-this-directory.txt
|
||||
|
||||
# Unit test / coverage reports
|
||||
htmlcov/
|
||||
.tox/
|
||||
.nox/
|
||||
.coverage
|
||||
.coverage.*
|
||||
.cache
|
||||
nosetests.xml
|
||||
coverage.xml
|
||||
*.cover
|
||||
*.py,cover
|
||||
.hypothesis/
|
||||
.pytest_cache/
|
||||
|
||||
# Translations
|
||||
*.mo
|
||||
*.pot
|
||||
|
||||
# Environments
|
||||
.env
|
||||
.venv
|
||||
env/
|
||||
venv/
|
||||
ENV/
|
||||
env.bak/
|
||||
venv.bak/
|
||||
|
||||
# mypy
|
||||
.mypy_cache/
|
||||
.dmypy.json
|
||||
dmypy.json
|
||||
|
||||
# Pyre type checker
|
||||
.pyre/
|
||||
|
||||
# pytype static type analyzer
|
||||
.pytype/
|
||||
|
||||
# Cython debug symbols
|
||||
cython_debug/
|
||||
205
skills/terraform-azurerm-set-diff-analyzer/scripts/README.md
Normal file
205
skills/terraform-azurerm-set-diff-analyzer/scripts/README.md
Normal file
@@ -0,0 +1,205 @@
|
||||
# Terraform AzureRM Set Diff Analyzer Script
|
||||
|
||||
A Python script that analyzes Terraform plan JSON and identifies "false-positive diffs" in AzureRM Set-type attributes.
|
||||
|
||||
## Overview
|
||||
|
||||
AzureRM Provider's Set-type attributes (such as `backend_address_pool`, `security_rule`, etc.) don't guarantee order, so when adding or removing elements, all elements appear as "changed". This script distinguishes such "false-positive diffs" from actual changes.
|
||||
|
||||
### Use Cases
|
||||
|
||||
- As an **Agent Skill** (recommended)
|
||||
- As a **CLI tool** for manual execution
|
||||
- For automated analysis in **CI/CD pipelines**
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Python 3.8 or higher
|
||||
- No additional packages required (uses only standard library)
|
||||
|
||||
## Usage
|
||||
|
||||
### Basic Usage
|
||||
|
||||
```bash
|
||||
# Read from file
|
||||
python analyze_plan.py plan.json
|
||||
|
||||
# Read from stdin
|
||||
terraform show -json plan.tfplan | python analyze_plan.py
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Short | Description | Default |
|
||||
|--------|-------|-------------|---------|
|
||||
| `--format` | `-f` | Output format (markdown/json/summary) | markdown |
|
||||
| `--exit-code` | `-e` | Return exit code based on changes | false |
|
||||
| `--quiet` | `-q` | Suppress warnings | false |
|
||||
| `--verbose` | `-v` | Show detailed warnings | false |
|
||||
| `--ignore-case` | - | Compare values case-insensitively | false |
|
||||
| `--attributes` | - | Path to custom attribute definition file | (built-in) |
|
||||
| `--include` | - | Filter resources to analyze (can specify multiple) | (all) |
|
||||
| `--exclude` | - | Filter resources to exclude (can specify multiple) | (none) |
|
||||
|
||||
### Exit Codes (with `--exit-code`)
|
||||
|
||||
| Code | Meaning |
|
||||
|------|---------|
|
||||
| 0 | No changes, or order-only changes |
|
||||
| 1 | Actual Set attribute changes |
|
||||
| 2 | Resource replacement (delete + create) |
|
||||
| 3 | Error |
|
||||
|
||||
## Output Formats
|
||||
|
||||
### Markdown (default)
|
||||
|
||||
Human-readable format for PR comments and reports.
|
||||
|
||||
```bash
|
||||
python analyze_plan.py plan.json --format markdown
|
||||
```
|
||||
|
||||
### JSON
|
||||
|
||||
Structured data for programmatic processing.
|
||||
|
||||
```bash
|
||||
python analyze_plan.py plan.json --format json
|
||||
```
|
||||
|
||||
Example output:
|
||||
```json
|
||||
{
|
||||
"summary": {
|
||||
"order_only_count": 3,
|
||||
"actual_set_changes_count": 1,
|
||||
"replace_count": 0
|
||||
},
|
||||
"has_real_changes": true,
|
||||
"resources": [...],
|
||||
"warnings": []
|
||||
}
|
||||
```
|
||||
|
||||
### Summary
|
||||
|
||||
One-line summary for CI/CD logs.
|
||||
|
||||
```bash
|
||||
python analyze_plan.py plan.json --format summary
|
||||
```
|
||||
|
||||
Example output:
|
||||
```
|
||||
🟢 3 order-only | 🟡 1 set changes
|
||||
```
|
||||
|
||||
## CI/CD Pipeline Usage
|
||||
|
||||
### GitHub Actions
|
||||
|
||||
```yaml
|
||||
name: Terraform Plan Analysis
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
paths:
|
||||
- '**.tf'
|
||||
|
||||
jobs:
|
||||
analyze:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Terraform
|
||||
uses: hashicorp/setup-terraform@v3
|
||||
|
||||
- name: Terraform Init & Plan
|
||||
run: |
|
||||
terraform init
|
||||
terraform plan -out=plan.tfplan
|
||||
terraform show -json plan.tfplan > plan.json
|
||||
|
||||
- name: Analyze Set Diff
|
||||
run: |
|
||||
python path/to/analyze_plan.py plan.json --format markdown > analysis.md
|
||||
|
||||
- name: Comment PR
|
||||
uses: marocchino/sticky-pull-request-comment@v2
|
||||
with:
|
||||
path: analysis.md
|
||||
```
|
||||
|
||||
### GitHub Actions (Gate with Exit Code)
|
||||
|
||||
```yaml
|
||||
- name: Analyze and Gate
|
||||
run: |
|
||||
python path/to/analyze_plan.py plan.json --exit-code --format summary
|
||||
# Fail on exit code 2 (resource replacement)
|
||||
continue-on-error: false
|
||||
```
|
||||
|
||||
### Azure Pipelines
|
||||
|
||||
```yaml
|
||||
- task: TerraformCLI@0
|
||||
inputs:
|
||||
command: 'plan'
|
||||
commandOptions: '-out=plan.tfplan'
|
||||
|
||||
- script: |
|
||||
terraform show -json plan.tfplan > plan.json
|
||||
python scripts/analyze_plan.py plan.json --format markdown > $(Build.ArtifactStagingDirectory)/analysis.md
|
||||
displayName: 'Analyze Plan'
|
||||
|
||||
- task: PublishBuildArtifacts@1
|
||||
inputs:
|
||||
pathToPublish: '$(Build.ArtifactStagingDirectory)/analysis.md'
|
||||
artifactName: 'plan-analysis'
|
||||
```
|
||||
|
||||
### Filtering Examples
|
||||
|
||||
Analyze only specific resources:
|
||||
```bash
|
||||
python analyze_plan.py plan.json --include application_gateway --include load_balancer
|
||||
```
|
||||
|
||||
Exclude specific resources:
|
||||
```bash
|
||||
python analyze_plan.py plan.json --exclude virtual_network
|
||||
```
|
||||
|
||||
## Interpreting Results
|
||||
|
||||
| Category | Meaning | Recommended Action |
|
||||
|----------|---------|-------------------|
|
||||
| 🟢 Order-only | False-positive diff, no actual change | Safe to ignore |
|
||||
| 🟡 Actual change | Set element added/removed/modified | Review the content, usually in-place update |
|
||||
| 🔴 Resource replacement | delete + create | Check for downtime impact |
|
||||
|
||||
## Custom Attribute Definitions
|
||||
|
||||
By default, uses `references/azurerm_set_attributes.json`, but you can specify a custom definition file:
|
||||
|
||||
```bash
|
||||
python analyze_plan.py plan.json --attributes /path/to/custom_attributes.json
|
||||
```
|
||||
|
||||
See `references/azurerm_set_attributes.md` for the definition file format.
|
||||
|
||||
## Limitations
|
||||
|
||||
- Only AzureRM resources (`azurerm_*`) are supported
|
||||
- Some resources/attributes may not be supported
|
||||
- Comparisons may be incomplete for attributes containing `after_unknown` (values determined after apply)
|
||||
- Comparisons may be incomplete for sensitive attributes (they are masked)
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [SKILL.md](../SKILL.md) - Usage as an Agent Skill
|
||||
- [azurerm_set_attributes.md](../references/azurerm_set_attributes.md) - Attribute definition reference
|
||||
940
skills/terraform-azurerm-set-diff-analyzer/scripts/analyze_plan.py
Executable file
940
skills/terraform-azurerm-set-diff-analyzer/scripts/analyze_plan.py
Executable file
@@ -0,0 +1,940 @@
|
||||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
"""
|
||||
Terraform Plan Analyzer for AzureRM Set-type Attributes
|
||||
|
||||
Analyzes terraform plan JSON output to distinguish between:
|
||||
- Order-only changes (false positives) in Set-type attributes
|
||||
- Actual additions/deletions/modifications
|
||||
|
||||
Usage:
|
||||
terraform show -json plan.tfplan | python analyze_plan.py
|
||||
python analyze_plan.py plan.json
|
||||
python analyze_plan.py plan.json --format json --exit-code
|
||||
|
||||
For CI/CD pipeline usage, see README.md in this directory.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import argparse
|
||||
import json
|
||||
import sys
|
||||
from dataclasses import dataclass, field
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict, List, Optional, Set
|
||||
|
||||
# Exit codes for --exit-code option
|
||||
EXIT_NO_CHANGES = 0
|
||||
EXIT_ORDER_ONLY = 0 # Order-only changes are not real changes
|
||||
EXIT_SET_CHANGES = 1 # Actual Set attribute changes
|
||||
EXIT_RESOURCE_REPLACE = 2 # Resource replacement (most severe)
|
||||
EXIT_ERROR = 3
|
||||
|
||||
# Default path to the external attributes JSON file (relative to this script)
|
||||
DEFAULT_ATTRIBUTES_PATH = (
|
||||
Path(__file__).parent.parent / "references" / "azurerm_set_attributes.json"
|
||||
)
|
||||
|
||||
|
||||
# Global configuration
|
||||
class Config:
|
||||
"""Global configuration for the analyzer."""
|
||||
|
||||
ignore_case: bool = False
|
||||
quiet: bool = False
|
||||
verbose: bool = False
|
||||
warnings: List[str] = []
|
||||
|
||||
|
||||
CONFIG = Config()
|
||||
|
||||
|
||||
def warn(message: str) -> None:
|
||||
"""Add a warning message."""
|
||||
CONFIG.warnings.append(message)
|
||||
if CONFIG.verbose:
|
||||
print(f"Warning: {message}", file=sys.stderr)
|
||||
|
||||
|
||||
def load_set_attributes(path: Optional[Path] = None) -> Dict[str, Dict[str, Any]]:
|
||||
"""Load Set-type attributes from external JSON file."""
|
||||
attributes_path = path or DEFAULT_ATTRIBUTES_PATH
|
||||
|
||||
try:
|
||||
with open(attributes_path, "r", encoding="utf-8") as f:
|
||||
data = json.load(f)
|
||||
return data.get("resources", {})
|
||||
except FileNotFoundError:
|
||||
warn(f"Attributes file not found: {attributes_path}")
|
||||
return {}
|
||||
except json.JSONDecodeError as e:
|
||||
print(f"Error: Invalid JSON in attributes file: {e}", file=sys.stderr)
|
||||
sys.exit(EXIT_ERROR)
|
||||
|
||||
|
||||
# Global variable to hold loaded attributes (initialized in main)
|
||||
AZURERM_SET_ATTRIBUTES: Dict[str, Any] = {}
|
||||
|
||||
|
||||
def get_attr_config(attr_def: Any) -> tuple:
|
||||
"""
|
||||
Parse attribute definition and return (key_attr, nested_attrs).
|
||||
|
||||
Attribute definition can be:
|
||||
- str: simple key attribute (e.g., "name")
|
||||
- None/null: no key attribute
|
||||
- dict: nested structure with "_key" and nested attributes
|
||||
"""
|
||||
if attr_def is None:
|
||||
return (None, {})
|
||||
if isinstance(attr_def, str):
|
||||
return (attr_def, {})
|
||||
if isinstance(attr_def, dict):
|
||||
key_attr = attr_def.get("_key")
|
||||
nested_attrs = {k: v for k, v in attr_def.items() if k != "_key"}
|
||||
return (key_attr, nested_attrs)
|
||||
return (None, {})
|
||||
|
||||
|
||||
@dataclass
|
||||
class SetAttributeChange:
|
||||
"""Represents a change in a Set-type attribute."""
|
||||
|
||||
attribute_name: str
|
||||
path: str = (
|
||||
"" # Full path for nested attributes (e.g., "rewrite_rule_set.rewrite_rule")
|
||||
)
|
||||
order_only_count: int = 0
|
||||
added: List[str] = field(default_factory=list)
|
||||
removed: List[str] = field(default_factory=list)
|
||||
modified: List[tuple] = field(default_factory=list)
|
||||
nested_changes: List["SetAttributeChange"] = field(default_factory=list)
|
||||
# For primitive sets (string/number arrays)
|
||||
is_primitive: bool = False
|
||||
primitive_added: List[Any] = field(default_factory=list)
|
||||
primitive_removed: List[Any] = field(default_factory=list)
|
||||
|
||||
|
||||
@dataclass
|
||||
class ResourceChange:
|
||||
"""Represents changes to a single resource."""
|
||||
|
||||
address: str
|
||||
resource_type: str
|
||||
actions: List[str] = field(default_factory=list)
|
||||
set_changes: List[SetAttributeChange] = field(default_factory=list)
|
||||
other_changes: List[str] = field(default_factory=list)
|
||||
is_replace: bool = False
|
||||
is_create: bool = False
|
||||
is_delete: bool = False
|
||||
|
||||
|
||||
@dataclass
|
||||
class AnalysisResult:
|
||||
"""Overall analysis result."""
|
||||
|
||||
resources: List[ResourceChange] = field(default_factory=list)
|
||||
order_only_count: int = 0
|
||||
actual_set_changes_count: int = 0
|
||||
replace_count: int = 0
|
||||
create_count: int = 0
|
||||
delete_count: int = 0
|
||||
other_changes_count: int = 0
|
||||
warnings: List[str] = field(default_factory=list)
|
||||
|
||||
|
||||
def get_element_key(element: Dict[str, Any], key_attr: Optional[str]) -> str:
|
||||
"""Extract the key value from a Set element."""
|
||||
if key_attr and key_attr in element:
|
||||
val = element[key_attr]
|
||||
if CONFIG.ignore_case and isinstance(val, str):
|
||||
return val.lower()
|
||||
return str(val)
|
||||
# Fall back to hash of sorted items for elements without a key attribute
|
||||
return str(hash(json.dumps(element, sort_keys=True)))
|
||||
|
||||
|
||||
def normalize_value(val: Any) -> Any:
|
||||
"""Normalize values for comparison (treat empty string and None as equivalent)."""
|
||||
if val == "" or val is None:
|
||||
return None
|
||||
if isinstance(val, list) and len(val) == 0:
|
||||
return None
|
||||
# Normalize numeric types (int vs float)
|
||||
if isinstance(val, float) and val.is_integer():
|
||||
return int(val)
|
||||
return val
|
||||
|
||||
|
||||
def normalize_for_comparison(val: Any) -> Any:
|
||||
"""Normalize value for comparison, including case-insensitive option."""
|
||||
val = normalize_value(val)
|
||||
if CONFIG.ignore_case and isinstance(val, str):
|
||||
return val.lower()
|
||||
return val
|
||||
|
||||
|
||||
def values_equivalent(before_val: Any, after_val: Any) -> bool:
|
||||
"""Check if two values are effectively equivalent."""
|
||||
return normalize_for_comparison(before_val) == normalize_for_comparison(after_val)
|
||||
|
||||
|
||||
def compare_elements(
|
||||
before: Dict[str, Any], after: Dict[str, Any], nested_attrs: Dict[str, Any] = None
|
||||
) -> tuple:
|
||||
"""
|
||||
Compare two elements and return (simple_diffs, nested_set_attrs).
|
||||
|
||||
simple_diffs: differences in non-Set attributes
|
||||
nested_set_attrs: list of (attr_name, before_val, after_val, attr_def) for nested Sets
|
||||
"""
|
||||
nested_attrs = nested_attrs or {}
|
||||
simple_diffs = {}
|
||||
nested_set_attrs = []
|
||||
|
||||
all_keys = set(before.keys()) | set(after.keys())
|
||||
|
||||
for key in all_keys:
|
||||
before_val = before.get(key)
|
||||
after_val = after.get(key)
|
||||
|
||||
# Check if this is a nested Set attribute
|
||||
if key in nested_attrs:
|
||||
if before_val != after_val:
|
||||
nested_set_attrs.append((key, before_val, after_val, nested_attrs[key]))
|
||||
elif not values_equivalent(before_val, after_val):
|
||||
simple_diffs[key] = {"before": before_val, "after": after_val}
|
||||
|
||||
return (simple_diffs, nested_set_attrs)
|
||||
|
||||
|
||||
def analyze_primitive_set(
|
||||
before_list: Optional[List[Any]],
|
||||
after_list: Optional[List[Any]],
|
||||
attr_name: str,
|
||||
path: str = "",
|
||||
) -> SetAttributeChange:
|
||||
"""Analyze changes in a primitive Set (string/number array)."""
|
||||
full_path = f"{path}.{attr_name}" if path else attr_name
|
||||
change = SetAttributeChange(
|
||||
attribute_name=attr_name, path=full_path, is_primitive=True
|
||||
)
|
||||
|
||||
before_set = set(before_list) if before_list else set()
|
||||
after_set = set(after_list) if after_list else set()
|
||||
|
||||
# Apply case-insensitive comparison if configured
|
||||
if CONFIG.ignore_case:
|
||||
before_normalized = {v.lower() if isinstance(v, str) else v for v in before_set}
|
||||
after_normalized = {v.lower() if isinstance(v, str) else v for v in after_set}
|
||||
else:
|
||||
before_normalized = before_set
|
||||
after_normalized = after_set
|
||||
|
||||
removed = before_normalized - after_normalized
|
||||
added = after_normalized - before_normalized
|
||||
|
||||
if removed:
|
||||
change.primitive_removed = list(removed)
|
||||
if added:
|
||||
change.primitive_added = list(added)
|
||||
|
||||
# Elements that exist in both (order change only)
|
||||
common = before_normalized & after_normalized
|
||||
if common and not removed and not added:
|
||||
change.order_only_count = len(common)
|
||||
|
||||
return change
|
||||
|
||||
|
||||
def analyze_set_attribute(
|
||||
before_list: Optional[List[Dict[str, Any]]],
|
||||
after_list: Optional[List[Dict[str, Any]]],
|
||||
key_attr: Optional[str],
|
||||
attr_name: str,
|
||||
nested_attrs: Dict[str, Any] = None,
|
||||
path: str = "",
|
||||
after_unknown: Optional[Dict[str, Any]] = None,
|
||||
) -> SetAttributeChange:
|
||||
"""Analyze changes in a Set-type attribute, including nested Sets."""
|
||||
full_path = f"{path}.{attr_name}" if path else attr_name
|
||||
change = SetAttributeChange(attribute_name=attr_name, path=full_path)
|
||||
nested_attrs = nested_attrs or {}
|
||||
|
||||
before_list = before_list or []
|
||||
after_list = after_list or []
|
||||
|
||||
# Handle non-list values (single element)
|
||||
if not isinstance(before_list, list):
|
||||
before_list = [before_list] if before_list else []
|
||||
if not isinstance(after_list, list):
|
||||
after_list = [after_list] if after_list else []
|
||||
|
||||
# Check if this is a primitive set (non-dict elements)
|
||||
has_primitive_before = any(
|
||||
not isinstance(e, dict) for e in before_list if e is not None
|
||||
)
|
||||
has_primitive_after = any(
|
||||
not isinstance(e, dict) for e in after_list if e is not None
|
||||
)
|
||||
|
||||
if has_primitive_before or has_primitive_after:
|
||||
# Handle primitive sets
|
||||
return analyze_primitive_set(before_list, after_list, attr_name, path)
|
||||
|
||||
# Build maps keyed by the key attribute
|
||||
before_map: Dict[str, Dict[str, Any]] = {}
|
||||
after_map: Dict[str, Dict[str, Any]] = {}
|
||||
|
||||
# Detect duplicate keys
|
||||
for e in before_list:
|
||||
if isinstance(e, dict):
|
||||
key = get_element_key(e, key_attr)
|
||||
if key in before_map:
|
||||
warn(f"Duplicate key '{key}' in before state for {full_path}")
|
||||
before_map[key] = e
|
||||
|
||||
for e in after_list:
|
||||
if isinstance(e, dict):
|
||||
key = get_element_key(e, key_attr)
|
||||
if key in after_map:
|
||||
warn(f"Duplicate key '{key}' in after state for {full_path}")
|
||||
after_map[key] = e
|
||||
|
||||
before_keys = set(before_map.keys())
|
||||
after_keys = set(after_map.keys())
|
||||
|
||||
# Find removed elements
|
||||
for key in before_keys - after_keys:
|
||||
display_key = key if key_attr else "(element)"
|
||||
change.removed.append(display_key)
|
||||
|
||||
# Find added elements
|
||||
for key in after_keys - before_keys:
|
||||
display_key = key if key_attr else "(element)"
|
||||
change.added.append(display_key)
|
||||
|
||||
# Compare common elements
|
||||
for key in before_keys & after_keys:
|
||||
before_elem = before_map[key]
|
||||
after_elem = after_map[key]
|
||||
|
||||
if before_elem == after_elem:
|
||||
# Exact match - this is just an order change
|
||||
change.order_only_count += 1
|
||||
else:
|
||||
# Content changed - check for meaningful differences
|
||||
simple_diffs, nested_set_list = compare_elements(
|
||||
before_elem, after_elem, nested_attrs
|
||||
)
|
||||
|
||||
# Process nested Set attributes recursively
|
||||
for nested_name, nested_before, nested_after, nested_def in nested_set_list:
|
||||
nested_key, sub_nested = get_attr_config(nested_def)
|
||||
nested_change = analyze_set_attribute(
|
||||
nested_before,
|
||||
nested_after,
|
||||
nested_key,
|
||||
nested_name,
|
||||
sub_nested,
|
||||
full_path,
|
||||
)
|
||||
if (
|
||||
nested_change.order_only_count > 0
|
||||
or nested_change.added
|
||||
or nested_change.removed
|
||||
or nested_change.modified
|
||||
or nested_change.nested_changes
|
||||
or nested_change.primitive_added
|
||||
or nested_change.primitive_removed
|
||||
):
|
||||
change.nested_changes.append(nested_change)
|
||||
|
||||
if simple_diffs:
|
||||
# Has actual differences in non-nested attributes
|
||||
display_key = key if key_attr else "(element)"
|
||||
change.modified.append((display_key, simple_diffs))
|
||||
elif not nested_set_list:
|
||||
# Only null/empty differences - treat as order change
|
||||
change.order_only_count += 1
|
||||
|
||||
return change
|
||||
|
||||
|
||||
def analyze_resource_change(
|
||||
resource_change: Dict[str, Any],
|
||||
include_filter: Optional[List[str]] = None,
|
||||
exclude_filter: Optional[List[str]] = None,
|
||||
) -> Optional[ResourceChange]:
|
||||
"""Analyze a single resource change from terraform plan."""
|
||||
resource_type = resource_change.get("type", "")
|
||||
address = resource_change.get("address", "")
|
||||
change = resource_change.get("change", {})
|
||||
actions = change.get("actions", [])
|
||||
|
||||
# Skip if no change or not an AzureRM resource
|
||||
if actions == ["no-op"] or not resource_type.startswith("azurerm_"):
|
||||
return None
|
||||
|
||||
# Apply filters
|
||||
if include_filter:
|
||||
if not any(f in resource_type for f in include_filter):
|
||||
return None
|
||||
if exclude_filter:
|
||||
if any(f in resource_type for f in exclude_filter):
|
||||
return None
|
||||
|
||||
before = change.get("before") or {}
|
||||
after = change.get("after") or {}
|
||||
after_unknown = change.get("after_unknown") or {}
|
||||
before_sensitive = change.get("before_sensitive") or {}
|
||||
after_sensitive = change.get("after_sensitive") or {}
|
||||
|
||||
# Determine action type
|
||||
is_create = actions == ["create"]
|
||||
is_delete = actions == ["delete"]
|
||||
is_replace = "delete" in actions and "create" in actions
|
||||
|
||||
result = ResourceChange(
|
||||
address=address,
|
||||
resource_type=resource_type,
|
||||
actions=actions,
|
||||
is_replace=is_replace,
|
||||
is_create=is_create,
|
||||
is_delete=is_delete,
|
||||
)
|
||||
|
||||
# Skip detailed Set analysis for create/delete (all elements are new/removed)
|
||||
if is_create or is_delete:
|
||||
return result
|
||||
|
||||
# Get Set attributes for this resource type
|
||||
set_attrs = AZURERM_SET_ATTRIBUTES.get(resource_type, {})
|
||||
|
||||
# Analyze Set-type attributes
|
||||
analyzed_attrs: Set[str] = set()
|
||||
for attr_name, attr_def in set_attrs.items():
|
||||
before_val = before.get(attr_name)
|
||||
after_val = after.get(attr_name)
|
||||
|
||||
# Warn about sensitive attributes
|
||||
if attr_name in before_sensitive or attr_name in after_sensitive:
|
||||
if before_sensitive.get(attr_name) or after_sensitive.get(attr_name):
|
||||
warn(
|
||||
f"Attribute '{attr_name}' in {address} contains sensitive values (comparison may be incomplete)"
|
||||
)
|
||||
|
||||
# Skip if attribute is not present or unchanged
|
||||
if before_val is None and after_val is None:
|
||||
continue
|
||||
if before_val == after_val:
|
||||
continue
|
||||
|
||||
# Only analyze if it's a list (Set in Terraform) or has changed
|
||||
if not isinstance(before_val, list) and not isinstance(after_val, list):
|
||||
continue
|
||||
|
||||
# Parse attribute definition for key and nested attrs
|
||||
key_attr, nested_attrs = get_attr_config(attr_def)
|
||||
|
||||
# Get after_unknown for this attribute
|
||||
attr_after_unknown = after_unknown.get(attr_name)
|
||||
|
||||
set_change = analyze_set_attribute(
|
||||
before_val,
|
||||
after_val,
|
||||
key_attr,
|
||||
attr_name,
|
||||
nested_attrs,
|
||||
after_unknown=attr_after_unknown,
|
||||
)
|
||||
|
||||
# Only include if there are actual findings
|
||||
if (
|
||||
set_change.order_only_count > 0
|
||||
or set_change.added
|
||||
or set_change.removed
|
||||
or set_change.modified
|
||||
or set_change.nested_changes
|
||||
or set_change.primitive_added
|
||||
or set_change.primitive_removed
|
||||
):
|
||||
result.set_changes.append(set_change)
|
||||
analyzed_attrs.add(attr_name)
|
||||
|
||||
# Find other (non-Set) changes
|
||||
all_keys = set(before.keys()) | set(after.keys())
|
||||
for key in all_keys:
|
||||
if key in analyzed_attrs:
|
||||
continue
|
||||
if key.startswith("_"): # Skip internal attributes
|
||||
continue
|
||||
before_val = before.get(key)
|
||||
after_val = after.get(key)
|
||||
if before_val != after_val:
|
||||
result.other_changes.append(key)
|
||||
|
||||
return result
|
||||
|
||||
|
||||
def collect_all_changes(set_change: SetAttributeChange, prefix: str = "") -> tuple:
|
||||
"""
|
||||
Recursively collect order-only and actual changes from nested structure.
|
||||
Returns (order_only_list, actual_change_list)
|
||||
"""
|
||||
order_only = []
|
||||
actual = []
|
||||
|
||||
display_name = (
|
||||
f"{prefix}{set_change.attribute_name}" if prefix else set_change.attribute_name
|
||||
)
|
||||
|
||||
has_actual_change = (
|
||||
set_change.added
|
||||
or set_change.removed
|
||||
or set_change.modified
|
||||
or set_change.primitive_added
|
||||
or set_change.primitive_removed
|
||||
)
|
||||
|
||||
if set_change.order_only_count > 0 and not has_actual_change:
|
||||
order_only.append((display_name, set_change))
|
||||
elif has_actual_change:
|
||||
actual.append((display_name, set_change))
|
||||
|
||||
# Process nested changes
|
||||
for nested in set_change.nested_changes:
|
||||
nested_order, nested_actual = collect_all_changes(nested, f"{display_name}.")
|
||||
order_only.extend(nested_order)
|
||||
actual.extend(nested_actual)
|
||||
|
||||
return (order_only, actual)
|
||||
|
||||
|
||||
def format_set_change(change: SetAttributeChange, indent: int = 0) -> List[str]:
|
||||
"""Format a single SetAttributeChange for output."""
|
||||
lines = []
|
||||
prefix = " " * indent
|
||||
|
||||
# Handle primitive sets
|
||||
if change.is_primitive:
|
||||
if change.primitive_added:
|
||||
lines.append(f"{prefix}**Added:**")
|
||||
for item in change.primitive_added:
|
||||
lines.append(f"{prefix} - {item}")
|
||||
if change.primitive_removed:
|
||||
lines.append(f"{prefix}**Removed:**")
|
||||
for item in change.primitive_removed:
|
||||
lines.append(f"{prefix} - {item}")
|
||||
if change.order_only_count > 0:
|
||||
lines.append(f"{prefix}**Order-only:** {change.order_only_count} elements")
|
||||
return lines
|
||||
|
||||
if change.added:
|
||||
lines.append(f"{prefix}**Added:**")
|
||||
for item in change.added:
|
||||
lines.append(f"{prefix} - {item}")
|
||||
|
||||
if change.removed:
|
||||
lines.append(f"{prefix}**Removed:**")
|
||||
for item in change.removed:
|
||||
lines.append(f"{prefix} - {item}")
|
||||
|
||||
if change.modified:
|
||||
lines.append(f"{prefix}**Modified:**")
|
||||
for item_key, diffs in change.modified:
|
||||
lines.append(f"{prefix} - {item_key}:")
|
||||
for diff_key, diff_val in diffs.items():
|
||||
before_str = json.dumps(diff_val["before"], ensure_ascii=False)
|
||||
after_str = json.dumps(diff_val["after"], ensure_ascii=False)
|
||||
lines.append(f"{prefix} - {diff_key}: {before_str} → {after_str}")
|
||||
|
||||
if change.order_only_count > 0:
|
||||
lines.append(f"{prefix}**Order-only:** {change.order_only_count} elements")
|
||||
|
||||
# Format nested changes
|
||||
for nested in change.nested_changes:
|
||||
if (
|
||||
nested.added
|
||||
or nested.removed
|
||||
or nested.modified
|
||||
or nested.nested_changes
|
||||
or nested.primitive_added
|
||||
or nested.primitive_removed
|
||||
):
|
||||
lines.append(f"{prefix}**Nested attribute `{nested.attribute_name}`:**")
|
||||
lines.extend(format_set_change(nested, indent + 1))
|
||||
|
||||
return lines
|
||||
|
||||
|
||||
def format_markdown_output(result: AnalysisResult) -> str:
|
||||
"""Format analysis results as Markdown."""
|
||||
lines = ["# Terraform Plan Analysis Results", ""]
|
||||
lines.append(
|
||||
'Analyzes AzureRM Set-type attribute changes and identifies order-only "false-positive diffs".'
|
||||
)
|
||||
lines.append("")
|
||||
|
||||
# Categorize changes (including nested)
|
||||
order_only_changes: List[tuple] = []
|
||||
actual_set_changes: List[tuple] = []
|
||||
replace_resources: List[ResourceChange] = []
|
||||
create_resources: List[ResourceChange] = []
|
||||
delete_resources: List[ResourceChange] = []
|
||||
other_changes: List[tuple] = []
|
||||
|
||||
for res in result.resources:
|
||||
if res.is_replace:
|
||||
replace_resources.append(res)
|
||||
elif res.is_create:
|
||||
create_resources.append(res)
|
||||
elif res.is_delete:
|
||||
delete_resources.append(res)
|
||||
|
||||
for set_change in res.set_changes:
|
||||
order_only, actual = collect_all_changes(set_change)
|
||||
for name, change in order_only:
|
||||
order_only_changes.append((res.address, name, change))
|
||||
for name, change in actual:
|
||||
actual_set_changes.append((res.address, name, change))
|
||||
|
||||
if res.other_changes:
|
||||
other_changes.append((res.address, res.other_changes))
|
||||
|
||||
# Section: Order-only changes (false positives)
|
||||
lines.append("## 🟢 Order-only Changes (No Impact)")
|
||||
lines.append("")
|
||||
if order_only_changes:
|
||||
lines.append(
|
||||
"The following changes are internal reordering of Set-type attributes only, with no actual resource changes."
|
||||
)
|
||||
lines.append("")
|
||||
for address, name, change in order_only_changes:
|
||||
lines.append(
|
||||
f"- `{address}`: **{name}** ({change.order_only_count} elements)"
|
||||
)
|
||||
else:
|
||||
lines.append("None")
|
||||
lines.append("")
|
||||
|
||||
# Section: Actual Set changes
|
||||
lines.append("## 🟡 Actual Set Attribute Changes")
|
||||
lines.append("")
|
||||
if actual_set_changes:
|
||||
for address, name, change in actual_set_changes:
|
||||
lines.append(f"### `{address}` - {name}")
|
||||
lines.append("")
|
||||
lines.extend(format_set_change(change))
|
||||
lines.append("")
|
||||
else:
|
||||
lines.append("None")
|
||||
lines.append("")
|
||||
|
||||
# Section: Resource replacements
|
||||
lines.append("## 🔴 Resource Replacement (Caution)")
|
||||
lines.append("")
|
||||
if replace_resources:
|
||||
lines.append(
|
||||
"The following resources will be deleted and recreated. This may cause downtime."
|
||||
)
|
||||
lines.append("")
|
||||
for res in replace_resources:
|
||||
lines.append(f"- `{res.address}`")
|
||||
else:
|
||||
lines.append("None")
|
||||
lines.append("")
|
||||
|
||||
# Section: Warnings
|
||||
if result.warnings:
|
||||
lines.append("## ⚠️ Warnings")
|
||||
lines.append("")
|
||||
for warning in result.warnings:
|
||||
lines.append(f"- {warning}")
|
||||
lines.append("")
|
||||
|
||||
return "\n".join(lines)
|
||||
|
||||
|
||||
def format_json_output(result: AnalysisResult) -> str:
|
||||
"""Format analysis results as JSON."""
|
||||
|
||||
def set_change_to_dict(change: SetAttributeChange) -> dict:
|
||||
d = {
|
||||
"attribute_name": change.attribute_name,
|
||||
"path": change.path,
|
||||
"order_only_count": change.order_only_count,
|
||||
"is_primitive": change.is_primitive,
|
||||
}
|
||||
if change.added:
|
||||
d["added"] = change.added
|
||||
if change.removed:
|
||||
d["removed"] = change.removed
|
||||
if change.modified:
|
||||
d["modified"] = [{"key": k, "diffs": v} for k, v in change.modified]
|
||||
if change.primitive_added:
|
||||
d["primitive_added"] = change.primitive_added
|
||||
if change.primitive_removed:
|
||||
d["primitive_removed"] = change.primitive_removed
|
||||
if change.nested_changes:
|
||||
d["nested_changes"] = [set_change_to_dict(n) for n in change.nested_changes]
|
||||
return d
|
||||
|
||||
def resource_to_dict(res: ResourceChange) -> dict:
|
||||
return {
|
||||
"address": res.address,
|
||||
"resource_type": res.resource_type,
|
||||
"actions": res.actions,
|
||||
"is_replace": res.is_replace,
|
||||
"is_create": res.is_create,
|
||||
"is_delete": res.is_delete,
|
||||
"set_changes": [set_change_to_dict(c) for c in res.set_changes],
|
||||
"other_changes": res.other_changes,
|
||||
}
|
||||
|
||||
output = {
|
||||
"summary": {
|
||||
"order_only_count": result.order_only_count,
|
||||
"actual_set_changes_count": result.actual_set_changes_count,
|
||||
"replace_count": result.replace_count,
|
||||
"create_count": result.create_count,
|
||||
"delete_count": result.delete_count,
|
||||
"other_changes_count": result.other_changes_count,
|
||||
},
|
||||
"has_real_changes": (
|
||||
result.actual_set_changes_count > 0
|
||||
or result.replace_count > 0
|
||||
or result.create_count > 0
|
||||
or result.delete_count > 0
|
||||
or result.other_changes_count > 0
|
||||
),
|
||||
"resources": [resource_to_dict(r) for r in result.resources],
|
||||
"warnings": result.warnings,
|
||||
}
|
||||
return json.dumps(output, indent=2, ensure_ascii=False)
|
||||
|
||||
|
||||
def format_summary_output(result: AnalysisResult) -> str:
|
||||
"""Format analysis results as a single-line summary."""
|
||||
parts = []
|
||||
|
||||
if result.order_only_count > 0:
|
||||
parts.append(f"🟢 {result.order_only_count} order-only")
|
||||
if result.actual_set_changes_count > 0:
|
||||
parts.append(f"🟡 {result.actual_set_changes_count} set changes")
|
||||
if result.replace_count > 0:
|
||||
parts.append(f"🔴 {result.replace_count} replacements")
|
||||
|
||||
if not parts:
|
||||
return "✅ No changes detected"
|
||||
|
||||
return " | ".join(parts)
|
||||
|
||||
|
||||
def analyze_plan(
|
||||
plan_json: Dict[str, Any],
|
||||
include_filter: Optional[List[str]] = None,
|
||||
exclude_filter: Optional[List[str]] = None,
|
||||
) -> AnalysisResult:
|
||||
"""Analyze a terraform plan JSON and return results."""
|
||||
result = AnalysisResult()
|
||||
|
||||
resource_changes = plan_json.get("resource_changes", [])
|
||||
|
||||
for rc in resource_changes:
|
||||
res = analyze_resource_change(rc, include_filter, exclude_filter)
|
||||
if res:
|
||||
result.resources.append(res)
|
||||
|
||||
# Count statistics
|
||||
if res.is_replace:
|
||||
result.replace_count += 1
|
||||
elif res.is_create:
|
||||
result.create_count += 1
|
||||
elif res.is_delete:
|
||||
result.delete_count += 1
|
||||
|
||||
if res.other_changes:
|
||||
result.other_changes_count += len(res.other_changes)
|
||||
|
||||
for set_change in res.set_changes:
|
||||
order_only, actual = collect_all_changes(set_change)
|
||||
result.order_only_count += len(order_only)
|
||||
result.actual_set_changes_count += len(actual)
|
||||
|
||||
# Add warnings from global config
|
||||
result.warnings = CONFIG.warnings.copy()
|
||||
|
||||
return result
|
||||
|
||||
|
||||
def determine_exit_code(result: AnalysisResult) -> int:
|
||||
"""Determine exit code based on analysis results."""
|
||||
if result.replace_count > 0:
|
||||
return EXIT_RESOURCE_REPLACE
|
||||
if (
|
||||
result.actual_set_changes_count > 0
|
||||
or result.create_count > 0
|
||||
or result.delete_count > 0
|
||||
):
|
||||
return EXIT_SET_CHANGES
|
||||
return EXIT_NO_CHANGES
|
||||
|
||||
|
||||
def parse_args() -> argparse.Namespace:
|
||||
"""Parse command line arguments."""
|
||||
parser = argparse.ArgumentParser(
|
||||
description="Analyze Terraform plan JSON for AzureRM Set-type attribute changes.",
|
||||
formatter_class=argparse.RawDescriptionHelpFormatter,
|
||||
epilog="""
|
||||
Examples:
|
||||
# Basic usage
|
||||
python analyze_plan.py plan.json
|
||||
|
||||
# From stdin
|
||||
terraform show -json plan.tfplan | python analyze_plan.py
|
||||
|
||||
# CI/CD with exit code
|
||||
python analyze_plan.py plan.json --exit-code
|
||||
|
||||
# JSON output for programmatic processing
|
||||
python analyze_plan.py plan.json --format json
|
||||
|
||||
# Summary for CI logs
|
||||
python analyze_plan.py plan.json --format summary
|
||||
|
||||
Exit codes (with --exit-code):
|
||||
0 - No changes or order-only changes
|
||||
1 - Actual Set attribute changes
|
||||
2 - Resource replacement detected
|
||||
3 - Error
|
||||
""",
|
||||
)
|
||||
|
||||
parser.add_argument(
|
||||
"plan_file",
|
||||
nargs="?",
|
||||
help="Path to terraform plan JSON file (reads from stdin if not provided)",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--format",
|
||||
"-f",
|
||||
choices=["markdown", "json", "summary"],
|
||||
default="markdown",
|
||||
help="Output format (default: markdown)",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--exit-code",
|
||||
"-e",
|
||||
action="store_true",
|
||||
help="Return exit code based on change severity",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--quiet",
|
||||
"-q",
|
||||
action="store_true",
|
||||
help="Suppress warnings and verbose output",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--verbose",
|
||||
"-v",
|
||||
action="store_true",
|
||||
help="Show detailed warnings and debug info",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--ignore-case",
|
||||
action="store_true",
|
||||
help="Ignore case when comparing string values",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--attributes", type=Path, help="Path to custom attributes JSON file"
|
||||
)
|
||||
parser.add_argument(
|
||||
"--include",
|
||||
action="append",
|
||||
help="Only analyze resources matching this pattern (can be repeated)",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--exclude",
|
||||
action="append",
|
||||
help="Exclude resources matching this pattern (can be repeated)",
|
||||
)
|
||||
|
||||
return parser.parse_args()
|
||||
|
||||
|
||||
def main():
|
||||
"""Main entry point."""
|
||||
global AZURERM_SET_ATTRIBUTES
|
||||
|
||||
args = parse_args()
|
||||
|
||||
# Configure global settings
|
||||
CONFIG.ignore_case = args.ignore_case
|
||||
CONFIG.quiet = args.quiet
|
||||
CONFIG.verbose = args.verbose
|
||||
CONFIG.warnings = []
|
||||
|
||||
# Load Set attributes from external JSON
|
||||
AZURERM_SET_ATTRIBUTES = load_set_attributes(args.attributes)
|
||||
|
||||
# Read plan input
|
||||
if args.plan_file:
|
||||
try:
|
||||
with open(args.plan_file, "r") as f:
|
||||
plan_json = json.load(f)
|
||||
except FileNotFoundError:
|
||||
print(f"Error: File not found: {args.plan_file}", file=sys.stderr)
|
||||
sys.exit(EXIT_ERROR)
|
||||
except json.JSONDecodeError as e:
|
||||
print(f"Error: Invalid JSON: {e}", file=sys.stderr)
|
||||
sys.exit(EXIT_ERROR)
|
||||
else:
|
||||
try:
|
||||
plan_json = json.load(sys.stdin)
|
||||
except json.JSONDecodeError as e:
|
||||
print(f"Error: Invalid JSON from stdin: {e}", file=sys.stderr)
|
||||
sys.exit(EXIT_ERROR)
|
||||
|
||||
# Check for empty plan
|
||||
resource_changes = plan_json.get("resource_changes", [])
|
||||
if not resource_changes:
|
||||
if args.format == "json":
|
||||
print(
|
||||
json.dumps(
|
||||
{
|
||||
"summary": {},
|
||||
"has_real_changes": False,
|
||||
"resources": [],
|
||||
"warnings": [],
|
||||
}
|
||||
)
|
||||
)
|
||||
elif args.format == "summary":
|
||||
print("✅ No changes detected")
|
||||
else:
|
||||
print("# Terraform Plan Analysis Results\n")
|
||||
print("No resource changes detected.")
|
||||
sys.exit(EXIT_NO_CHANGES)
|
||||
|
||||
# Analyze the plan
|
||||
result = analyze_plan(plan_json, args.include, args.exclude)
|
||||
|
||||
# Format output
|
||||
if args.format == "json":
|
||||
output = format_json_output(result)
|
||||
elif args.format == "summary":
|
||||
output = format_summary_output(result)
|
||||
else:
|
||||
output = format_markdown_output(result)
|
||||
|
||||
print(output)
|
||||
|
||||
# Determine exit code
|
||||
if args.exit_code:
|
||||
sys.exit(determine_exit_code(result))
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
196
skills/winapp-cli/SKILL.md
Normal file
196
skills/winapp-cli/SKILL.md
Normal file
@@ -0,0 +1,196 @@
|
||||
---
|
||||
name: winapp-cli
|
||||
description: 'Windows App Development CLI (winapp) for building, packaging, and deploying Windows applications. Use when asked to initialize Windows app projects, create MSIX packages, generate AppxManifest.xml, manage development certificates, add package identity for debugging, sign packages, or access Windows SDK build tools. Supports .NET, C++, Electron, Rust, Tauri, and cross-platform frameworks targeting Windows.'
|
||||
---
|
||||
|
||||
# Windows App Development CLI
|
||||
|
||||
The Windows App Development CLI (`winapp`) is a command-line interface for managing Windows SDKs, MSIX packaging, generating app identity, manifests, certificates, and using build tools with any app framework. It bridges the gap between cross-platform development and Windows-native capabilities.
|
||||
|
||||
## When to Use This Skill
|
||||
|
||||
Use this skill when you need to:
|
||||
|
||||
- Initialize a Windows app project with SDK setup, manifests, and certificates
|
||||
- Create MSIX packages from application directories
|
||||
- Generate or manage AppxManifest.xml files
|
||||
- Create and install development certificates for signing
|
||||
- Add package identity for debugging Windows APIs
|
||||
- Sign MSIX packages or executables
|
||||
- Access Windows SDK build tools from any framework
|
||||
- Build Windows apps using cross-platform frameworks (Electron, Rust, Tauri, Qt)
|
||||
- Set up CI/CD pipelines for Windows app deployment
|
||||
- Access Windows APIs that require package identity (notifications, Windows AI, shell integration)
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Windows 10 or later
|
||||
- winapp CLI installed via one of these methods:
|
||||
- **WinGet**: `winget install Microsoft.WinAppCli --source winget`
|
||||
- **NPM** (for Electron): `npm install @microsoft/winappcli --save-dev`
|
||||
- **GitHub Actions/Azure DevOps**: Use [setup-WinAppCli](https://github.com/microsoft/setup-WinAppCli) action
|
||||
- **Manual**: Download from [GitHub Releases](https://github.com/microsoft/WinAppCli/releases/latest)
|
||||
|
||||
## Core Capabilities
|
||||
|
||||
### 1. Project Initialization (`winapp init`)
|
||||
|
||||
Initialize a directory with required assets (manifest, certificates, libraries) for building a modern Windows app. Supports SDK installation modes: `stable`, `preview`, `experimental`, or `none`.
|
||||
|
||||
### 2. MSIX Packaging (`winapp pack`)
|
||||
|
||||
Create MSIX packages from prepared directories with optional signing, certificate generation, and self-contained deployment bundling.
|
||||
|
||||
### 3. Package Identity for Debugging (`winapp create-debug-identity`)
|
||||
|
||||
Add temporary package identity to executables for debugging Windows APIs that require identity (notifications, Windows AI, shell integration) without full packaging.
|
||||
|
||||
### 4. Manifest Management (`winapp manifest`)
|
||||
|
||||
Generate AppxManifest.xml files and update image assets from source images, automatically creating all required sizes and aspect ratios.
|
||||
|
||||
### 5. Certificate Management (`winapp cert`)
|
||||
|
||||
Generate development certificates and install them to the local machine store for signing packages.
|
||||
|
||||
### 6. Package Signing (`winapp sign`)
|
||||
|
||||
Sign MSIX packages and executables with PFX certificates, with optional timestamp server support.
|
||||
|
||||
### 7. SDK Build Tools Access (`winapp tool`)
|
||||
|
||||
Run Windows SDK build tools with properly configured paths from any framework or build system.
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### Example 1: Initialize and Package a Windows App
|
||||
|
||||
```bash
|
||||
# Initialize workspace with defaults
|
||||
winapp init
|
||||
|
||||
# Build your application (framework-specific)
|
||||
# ...
|
||||
|
||||
# Create signed MSIX package
|
||||
winapp pack ./build-output --generate-cert --output MyApp.msix
|
||||
```
|
||||
|
||||
### Example 2: Debug with Package Identity
|
||||
|
||||
```bash
|
||||
# Add debug identity to executable for testing Windows APIs
|
||||
winapp create-debug-identity ./bin/MyApp.exe
|
||||
|
||||
# Run your app - it now has package identity
|
||||
./bin/MyApp.exe
|
||||
```
|
||||
|
||||
### Example 3: CI/CD Pipeline Setup
|
||||
|
||||
```yaml
|
||||
# GitHub Actions example
|
||||
- name: Setup winapp CLI
|
||||
uses: microsoft/setup-WinAppCli@v1
|
||||
|
||||
- name: Initialize and Package
|
||||
run: |
|
||||
winapp init --no-prompt
|
||||
winapp pack ./build-output --output MyApp.msix
|
||||
```
|
||||
|
||||
### Example 4: Electron App Integration
|
||||
|
||||
```bash
|
||||
# Install via npm
|
||||
npm install @microsoft/winappcli --save-dev
|
||||
|
||||
# Initialize and add debug identity for Electron
|
||||
npx winapp init
|
||||
npx winapp node add-electron-debug-identity
|
||||
|
||||
# Package for distribution
|
||||
npx winapp pack ./out --output MyElectronApp.msix
|
||||
```
|
||||
|
||||
## Guidelines
|
||||
|
||||
1. **Run `winapp init` first** - Always initialize your project before using other commands to ensure SDK setup, manifest, and certificates are configured.
|
||||
2. **Re-run `create-debug-identity` after manifest changes** - Package identity must be recreated whenever AppxManifest.xml is modified.
|
||||
3. **Use `--no-prompt` for CI/CD** - Prevents interactive prompts in automated pipelines by using default values.
|
||||
4. **Use `winapp restore` for shared projects** - Recreates the exact environment state defined in `winapp.yaml` across machines.
|
||||
5. **Generate assets from a single image** - Use `winapp manifest update-assets` with one logo to generate all required icon sizes.
|
||||
|
||||
## Common Patterns
|
||||
|
||||
### Pattern: Initialize New Project
|
||||
|
||||
```bash
|
||||
cd my-project
|
||||
winapp init
|
||||
# Creates: AppxManifest.xml, development certificate, SDK configuration, winapp.yaml
|
||||
```
|
||||
|
||||
### Pattern: Package with Existing Certificate
|
||||
|
||||
```bash
|
||||
winapp pack ./build-output --cert ./mycert.pfx --cert-password secret --output MyApp.msix
|
||||
```
|
||||
|
||||
### Pattern: Self-Contained Deployment
|
||||
|
||||
```bash
|
||||
# Bundle Windows App SDK runtime with the package
|
||||
winapp pack ./my-app --self-contained --generate-cert
|
||||
```
|
||||
|
||||
### Pattern: Update Package Versions
|
||||
|
||||
```bash
|
||||
# Update to latest stable SDKs
|
||||
winapp update
|
||||
|
||||
# Or update to preview SDKs
|
||||
winapp update --setup-sdks preview
|
||||
```
|
||||
|
||||
## Limitations
|
||||
|
||||
- Windows 10 or later required (Windows-only CLI)
|
||||
- Package identity debugging requires re-running `create-debug-identity` after any manifest changes
|
||||
- Self-contained deployment increases package size by bundling the Windows App SDK runtime
|
||||
- Development certificates are for testing only; production requires trusted certificates
|
||||
- Some Windows APIs require specific capability declarations in the manifest
|
||||
- winapp CLI is in public preview and subject to change
|
||||
|
||||
## Windows APIs Enabled by Package Identity
|
||||
|
||||
Package identity unlocks access to powerful Windows APIs:
|
||||
|
||||
| API Category | Examples |
|
||||
| ------------ | -------- |
|
||||
| **Notifications** | Interactive native notifications, notification management |
|
||||
| **Windows AI** | On-device LLM, text/image AI APIs (Phi Silica, Windows ML) |
|
||||
| **Shell Integration** | Explorer, Taskbar, Share sheet integration |
|
||||
| **Protocol Handlers** | Custom URI schemes (`yourapp://`) |
|
||||
| **Device Access** | Camera, microphone, location (with consent) |
|
||||
| **Background Tasks** | Run when app is closed |
|
||||
| **File Associations** | Open file types with your app |
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
| Issue | Solution |
|
||||
| ----- | -------- |
|
||||
| Certificate not trusted | Run `winapp cert install <cert-path>` to install to local machine store |
|
||||
| Package identity not working | Run `winapp create-debug-identity` after any manifest changes |
|
||||
| SDK not found | Run `winapp restore` or `winapp update` to ensure SDKs are installed |
|
||||
| Signing fails | Verify certificate password and ensure cert is not expired |
|
||||
|
||||
## References
|
||||
|
||||
- [GitHub Repository](https://github.com/microsoft/WinAppCli)
|
||||
- [Full CLI Documentation](https://github.com/microsoft/WinAppCli/blob/main/docs/usage.md)
|
||||
- [Sample Applications](https://github.com/microsoft/WinAppCli/tree/main/samples)
|
||||
- [Windows App SDK](https://learn.microsoft.com/windows/apps/windows-app-sdk/)
|
||||
- [MSIX Packaging Overview](https://learn.microsoft.com/windows/msix/overview)
|
||||
- [Package Identity Overview](https://learn.microsoft.com/windows/apps/desktop/modernize/package-identity-overview)
|
||||
Reference in New Issue
Block a user