mirror of
https://github.com/github/awesome-copilot.git
synced 2026-08-30 20:43:06 +00:00
* Initial pass at bringing a website experience to copilot cli for beginners * dropped the number from the heading * Adding codeowner * agentic workflow to keep the docs in sync * Making it more aligned with the source material * Removing the badges and TOC since we get some of that from astro * updating the agentic workflow * Adding learning hub to llms.txt * Removing nav that comes from the source markdown files
106 lines
4.1 KiB
TypeScript
106 lines
4.1 KiB
TypeScript
import type { APIRoute } from "astro";
|
|
import { getCollection } from "astro:content";
|
|
import agentsData from "../../public/data/agents.json";
|
|
import instructionsData from "../../public/data/instructions.json";
|
|
import skillsData from "../../public/data/skills.json";
|
|
|
|
// Base URL for absolute links (to raw GitHub content)
|
|
const GITHUB_RAW_BASE = "https://raw.githubusercontent.com/github/awesome-copilot/main";
|
|
const WEBSITE_BASE = "https://awesome-copilot.github.com";
|
|
|
|
const normalizeDescription = (value?: string) =>
|
|
(value || "No description available").replace(/\s+/g, " ").trim();
|
|
|
|
const learningHubRoute = (id: string) =>
|
|
id.replace(/\.md$/, "").replace(/\/index$/, "");
|
|
|
|
export const GET: APIRoute = async () => {
|
|
const agents = agentsData.items;
|
|
const instructions = instructionsData.items;
|
|
const skills = skillsData.items;
|
|
const learningHubArticles = (await getCollection("docs"))
|
|
.filter(({ id }) => id.startsWith("learning-hub/"))
|
|
.sort((left, right) =>
|
|
learningHubRoute(left.id).localeCompare(learningHubRoute(right.id)),
|
|
);
|
|
|
|
const url = (path: string) => `${GITHUB_RAW_BASE}/${path}`;
|
|
const siteUrl = (route: string) => new URL(`${route}/`, WEBSITE_BASE).toString();
|
|
|
|
let content = "";
|
|
|
|
// H1 header (required)
|
|
content += "# Awesome GitHub Copilot\n\n";
|
|
|
|
// Summary blockquote (optional but recommended)
|
|
content +=
|
|
"> A community-driven collection of custom agents, instructions, and skills to enhance GitHub Copilot experiences across various domains, languages, and use cases.\n\n";
|
|
|
|
// Add overview section
|
|
content += "## Overview\n\n";
|
|
content +=
|
|
"This repository provides resources to customize and enhance GitHub Copilot:\n\n";
|
|
content +=
|
|
"- **Agents**: Specialized GitHub Copilot agents that integrate with MCP servers\n";
|
|
content +=
|
|
"- **Instructions**: Coding standards and best practices applied to specific file patterns\n";
|
|
content +=
|
|
"- **Skills**: Self-contained folders with instructions and bundled resources for specialized tasks\n";
|
|
content +=
|
|
"- **Learning Hub**: Curated guides, tutorials, and reference material published on the website\n\n";
|
|
|
|
// Process Learning Hub documentation
|
|
content += "## Learning Hub\n\n";
|
|
for (const article of learningHubArticles) {
|
|
const description = normalizeDescription(article.data.description);
|
|
content += `- [${article.data.title}](${siteUrl(learningHubRoute(article.id))}): ${description}\n`;
|
|
}
|
|
content += "\n";
|
|
|
|
// Process Agents
|
|
content += "## Agents\n\n";
|
|
for (const agent of agents) {
|
|
const description = normalizeDescription(agent.description);
|
|
content += `- [${agent.title}](${url(agent.path)}): ${description}\n`;
|
|
}
|
|
content += "\n";
|
|
|
|
// Process Instructions
|
|
content += "## Instructions\n\n";
|
|
for (const instruction of instructions) {
|
|
const description = normalizeDescription(instruction.description);
|
|
content += `- [${instruction.title}](${url(instruction.path)}): ${description}\n`;
|
|
}
|
|
content += "\n";
|
|
|
|
// Process Skills
|
|
content += "## Skills\n\n";
|
|
for (const skill of skills) {
|
|
const description = normalizeDescription(skill.description);
|
|
content += `- [${skill.title}](${url(skill.skillFile)}): ${description}\n`;
|
|
}
|
|
content += "\n";
|
|
|
|
// Add documentation links
|
|
content += "## Documentation\n\n";
|
|
content +=
|
|
`- [README.md](${url("README.md")}): Main documentation and getting started guide\n`;
|
|
content +=
|
|
`- [CONTRIBUTING.md](${url("CONTRIBUTING.md")}): Guidelines for contributing to this repository\n`;
|
|
content +=
|
|
`- [CODE_OF_CONDUCT.md](${url("CODE_OF_CONDUCT.md")}): Community standards and expectations\n`;
|
|
content += `- [SECURITY.md](${url("SECURITY.md")}): Security policies and reporting\n`;
|
|
content +=
|
|
`- [AGENTS.md](${url("AGENTS.md")}): Project overview and setup commands\n\n`;
|
|
|
|
// Add repository information
|
|
content += "## Repository\n\n";
|
|
content += "- **GitHub**: https://github.com/github/awesome-copilot\n";
|
|
content += "- **License**: MIT\n";
|
|
content += "- **Website**: https://awesome-copilot.github.com\n";
|
|
|
|
return new Response(content, {
|
|
headers: { "Content-Type": "text/plain; charset=utf-8" },
|
|
});
|
|
};
|