Does this skill only work with GitHub URLs?

While it is optimized for GitHub repositories to provide richer metadata, it can also parse general website URLs for basic project information.

In what language is the documentation generated?

The generated notes follow a 'Chinese-first' style, translating general explanations while keeping specific technical commands and terms in English.

Where does the skill store the generated files?

Files are stored in the '05_tools/' directory within your configured project or vault root.

What happens if a project note already exists?

By default, the skill will overwrite existing files with the same name to ensure the documentation reflects the most recent project updates.

Project Documentation Generator

Name: Project Documentation Generator
Author: 0boluan0

by0boluan0

•

Learning & Documentation

Generates structured, Chinese-first markdown documentation for software projects directly from GitHub or website URLs.

The Project Documentation Generator skill automates the process of creating comprehensive notes within an Obsidian vault by extracting metadata from project URLs. By parsing GitHub APIs, README files, and website metadata, it builds a standardized note containing installation steps, usage guides, and troubleshooting tips. This skill is ideal for developers and researchers building a knowledge base, as it ensures all tool-related documentation follows a consistent, bilingual format without manual effort.

Key Features

01Chinese-first documentation style that preserves essential technical English terms

025 GitHub stars

03Generates detailed sections for installation, first-run, and troubleshooting

04Automated metadata extraction from GitHub repositories and project websites

05Smart source priority mapping from releases, READMEs, and page metadata

06Standardized markdown output optimized for Obsidian-based vaults

Use Cases

01Building a personal library of development tools and software libraries

02Rapidly documenting new GitHub repositories during research phases

03Automating the creation of quick-start guides for team workflows

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add 0boluan0/notes_on_economic_statistics tool

For use in Claude.ai and ChatGPT

Download Skill