Initial commit
This commit is contained in:
Zhongwei Li
9
.claude-plugin/plugin.json
Normal file
9
.claude-plugin/plugin.json
Normal file
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"name": "example-skill",
|
||||
"description": "Demonstrates proper skill structure and frontmatter format for marketplace skills",
|
||||
"version": "1.0.0",
|
||||
"author": "Skills Marketplace Team",
|
||||
"skills": [
|
||||
"./"
|
||||
]
|
||||
}
|
||||
3
README.md
Normal file
3
README.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# example-skill
|
||||
|
||||
Demonstrates proper skill structure and frontmatter format for marketplace skills
|
||||
176
SKILL.md
Normal file
176
SKILL.md
Normal file
@@ -0,0 +1,176 @@
|
||||
---
|
||||
name: example-skill
|
||||
description: Demonstrates proper skill structure and frontmatter format for marketplace skills
|
||||
version: 1.0.0
|
||||
author: Skills Marketplace Team
|
||||
category: examples
|
||||
tags:
|
||||
- template
|
||||
- documentation
|
||||
- best-practices
|
||||
license: MIT
|
||||
---
|
||||
|
||||
# Example Skill
|
||||
|
||||
This skill demonstrates the proper structure and documentation format for Skills Marketplace submissions.
|
||||
|
||||
## Purpose
|
||||
|
||||
Use this skill as a **template** when creating your own skills. It shows:
|
||||
|
||||
- ✅ Proper YAML frontmatter format
|
||||
- ✅ Required and optional fields
|
||||
- ✅ Clear documentation structure
|
||||
- ✅ Usage examples
|
||||
- ✅ Best practices
|
||||
|
||||
## Features
|
||||
|
||||
- **Complete frontmatter** - Shows all recommended fields
|
||||
- **Clear documentation** - Well-organized sections
|
||||
- **Usage examples** - Demonstrates how to use the skill
|
||||
- **Best practices** - Follows marketplace guidelines
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
# Add the marketplace
|
||||
/plugin marketplace add token-eater/skills-marketplace
|
||||
|
||||
# Install this example skill
|
||||
/plugin install example-skill
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
This is an example skill for demonstration purposes. In a real skill, this section would explain:
|
||||
|
||||
1. **How to use the skill** - Step-by-step instructions
|
||||
2. **Commands** - Specific commands or workflows
|
||||
3. **Configuration** - Any setup required
|
||||
4. **Tips** - Helpful usage tips
|
||||
|
||||
### Example Usage
|
||||
|
||||
```bash
|
||||
# Example command (this is a template - replace with real usage)
|
||||
/skill example-skill --help
|
||||
```
|
||||
|
||||
## Structure
|
||||
|
||||
This skill follows the standard marketplace structure:
|
||||
|
||||
```
|
||||
skills/example-skill/
|
||||
├── SKILL.md # This file (required)
|
||||
├── scripts/ # Optional: Helper scripts
|
||||
├── references/ # Optional: Reference documentation
|
||||
└── assets/ # Optional: Images, templates, etc.
|
||||
```
|
||||
|
||||
## Frontmatter Fields
|
||||
|
||||
### Required Fields
|
||||
|
||||
```yaml
|
||||
name: example-skill # Unique identifier (kebab-case)
|
||||
description: Brief description # 1-2 sentence summary
|
||||
version: 1.0.0 # Semantic version (X.Y.Z)
|
||||
author: Author Name # Your name or organization
|
||||
category: examples # Primary category
|
||||
tags: # 2-5 searchable keywords
|
||||
- template
|
||||
- documentation
|
||||
```
|
||||
|
||||
### Optional Fields
|
||||
|
||||
```yaml
|
||||
license: MIT # License type
|
||||
repository: https://github... # Source code URL
|
||||
homepage: https://example.com # Documentation URL
|
||||
dependencies: # Required tools/packages
|
||||
- tool-name
|
||||
```
|
||||
|
||||
## Categories
|
||||
|
||||
Choose the most appropriate category for your skill:
|
||||
|
||||
- `productivity` - Task management, workflows, automation
|
||||
- `development` - Git, testing, code quality, deployment
|
||||
- `data` - Data processing, visualization, reporting
|
||||
- `documentation` - Markdown, diagrams, API docs
|
||||
- `devops` - CI/CD, containers, infrastructure
|
||||
- `ai-ml` - AI/ML integration, training, evaluation
|
||||
- `security` - Security scanning, verification, compliance
|
||||
- `web` - Web scraping, APIs, frontend tools
|
||||
- `knowledge` - Research, memory, note-taking
|
||||
- `examples` - Templates and learning resources
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Documentation
|
||||
|
||||
- ✅ Write clear, concise descriptions
|
||||
- ✅ Include usage examples
|
||||
- ✅ Document all dependencies
|
||||
- ✅ Provide troubleshooting tips
|
||||
|
||||
### Structure
|
||||
|
||||
- ✅ Keep skills focused (single purpose)
|
||||
- ✅ Use semantic versioning
|
||||
- ✅ Organize files logically
|
||||
- ✅ Include only necessary files
|
||||
|
||||
### Security
|
||||
|
||||
- ⚠️ Never hardcode API keys or secrets
|
||||
- ⚠️ Never commit credentials
|
||||
- ✅ Document how to configure secrets
|
||||
- ✅ Use `.gitignore` for sensitive files
|
||||
|
||||
## Contributing
|
||||
|
||||
To create your own skill based on this example:
|
||||
|
||||
1. **Copy the structure**:
|
||||
```bash
|
||||
cp -r skills/example-skill skills/your-skill-name
|
||||
```
|
||||
|
||||
2. **Update SKILL.md**:
|
||||
- Change frontmatter fields (name, description, etc.)
|
||||
- Write your skill documentation
|
||||
- Add usage examples
|
||||
|
||||
3. **Test locally**:
|
||||
```bash
|
||||
/plugin marketplace add ./skills-marketplace
|
||||
/plugin install your-skill-name
|
||||
```
|
||||
|
||||
4. **Submit**: See [Contributing Guide](../../docs/contributing.md)
|
||||
|
||||
## Resources
|
||||
|
||||
- 📖 [Creating Skills Guide](../../docs/creating-skills.md)
|
||||
- 🤝 [Contributing Guide](../../docs/contributing.md)
|
||||
- 📥 [Installation Guide](../../docs/installation.md)
|
||||
- 🏗️ [Architecture Guide](../../docs/architecture.md)
|
||||
|
||||
## License
|
||||
|
||||
MIT License - Free to use, modify, and distribute.
|
||||
|
||||
## Support
|
||||
|
||||
- 💬 [GitHub Discussions](https://github.com/token-eater/skills-marketplace/discussions)
|
||||
- 🐛 [Report Issues](https://github.com/token-eater/skills-marketplace/issues)
|
||||
|
||||
---
|
||||
|
||||
**Ready to create your own skill?** Use this as a template and see the [Creating Skills Guide](../../docs/creating-skills.md) for detailed instructions.
|
||||
45
plugin.lock.json
Normal file
45
plugin.lock.json
Normal file
@@ -0,0 +1,45 @@
|
||||
{
|
||||
"$schema": "internal://schemas/plugin.lock.v1.json",
|
||||
"pluginId": "gh:Token-Eater/skills-marketplace:skills/example-skill",
|
||||
"normalized": {
|
||||
"repo": null,
|
||||
"ref": "refs/tags/v20251128.0",
|
||||
"commit": "25d67bf3dffc4f76291b3bfbd52c41ef2272c13f",
|
||||
"treeHash": "28456fc03dd5c5ea1519c66a9ba7bc43ff9e8eec6d242bdbc201aa609af42956",
|
||||
"generatedAt": "2025-11-28T10:12:54.369151Z",
|
||||
"toolVersion": "publish_plugins.py@0.2.0"
|
||||
},
|
||||
"origin": {
|
||||
"remote": "git@github.com:zhongweili/42plugin-data.git",
|
||||
"branch": "master",
|
||||
"commit": "aa1497ed0949fd50e99e70d6324a29c5b34f9390",
|
||||
"repoRoot": "/Users/zhongweili/projects/openmind/42plugin-data"
|
||||
},
|
||||
"manifest": {
|
||||
"name": "example-skill",
|
||||
"description": "Demonstrates proper skill structure and frontmatter format for marketplace skills",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
"content": {
|
||||
"files": [
|
||||
{
|
||||
"path": "README.md",
|
||||
"sha256": "aee3d061d894de0d7d824dc8efda095e77433dd8e278c0d778cb8f0a4c2b9d0e"
|
||||
},
|
||||
{
|
||||
"path": "SKILL.md",
|
||||
"sha256": "c293590525cbd7cc826d1314a2c2d95b84690867d7010a21dd0561e37fac3bfe"
|
||||
},
|
||||
{
|
||||
"path": ".claude-plugin/plugin.json",
|
||||
"sha256": "39294564941fbb447a923fee1d0a1a268b6529ce9633765df8b0232b8be9a45f"
|
||||
}
|
||||
],
|
||||
"dirSha256": "28456fc03dd5c5ea1519c66a9ba7bc43ff9e8eec6d242bdbc201aa609af42956"
|
||||
},
|
||||
"security": {
|
||||
"scannedAt": null,
|
||||
"scannerVersion": null,
|
||||
"flags": []
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user