$ show PKUFlyingPig/cs-self-learning
This repository is a comprehensive, community-curated self-learning guide for computer science, primarily serving as a static documentation website built with MkDocs and deployed via GitHub Pages. It contains hundreds of structured course recommendation pages organized by category (e.g., programming, operating systems, machine learning), each with metadata such as prerequisites, difficulty, estimated time, and resource links. The site supports bilingual content (Chinese and English) via the mkdocs-static-i18n plugin and includes a commenting system (Giscus) for community discussion. While not a software application in the traditional sense, it functions as a curated educational resource with a consistent template for contributions, automated CI/CD, and a well-maintained navigation structure. The repository's value lies in its curated content and organization, not in executable code or data pipelines.
The LLM identified 3 files worth highlighting for reuse:
A markdown template that enforces a consistent structure for course recommendation pages, including fields for description, prerequisites, programming languages, difficulty, class hours, and resources. This pattern is reusable for any curated educational content project, allowing contributors to follow a standardized format without requiring deep knowledge of the site's architecture.
A GitHub Actions workflow that builds the MkDocs site and deploys it to GitHub Pages on pushes to the master branch. This is a reusable CI pattern for any MkDocs-based documentation project, demonstrating best practices for automated deployment with minimal configuration.
A custom MkDocs partial that integrates Giscus (a GitHub Discussions-based commenting system) into the site. This pattern is reusable for adding lightweight, GitHub-backed comments to any static documentation site, enabling community feedback without external services.