0l1v3rr / 0l1v3rr/github-readme-tech-stack
📚 Add more themes
- 主要语言
- TypeScript
- 星标
- 261
- 派生
- 46
- PR 合并指标
- 30 天内没有已合并 PR
描述
We'd love to expand our themes with new, cool ones! If you have a fancy theme in mind or would like to see and design new themes, here are simple instructions on how to get started. [(Here are the currently available themes.)](https://github.com/0l1v3rr/github-readme-tech-stack/blob/master/docs/THEMES.md)
### Requesting a theme
1. Open an issue describing your new theme. If possible, include an image. It can be a theme from another README card project.
2. Indicate in the issue if you want someone else to add the theme.
### Adding the theme
1. Fork the repository
2. Clone your fork
3. Locate the [`themes.ts`](https://github.com/0l1v3rr/github-readme-tech-stack/blob/master/src/const/themes.ts) file
4. Set your theme colors using the `themes.set()` function
5. Add your new theme to the [`THEMES.md`](https://github.com/0l1v3rr/github-readme-tech-stack/blob/master/docs/THEMES.md) file
6. Commit and push your changes
7. Open a [Pull Request](https://github.com/0l1v3rr/github-readme-tech-stack/pulls) containing your changes. Please also include a screenshot of your new theme in the PR.
**`themes.set()` example:**
```ts
// the theme name should be snake_case
themes.set("theme_name", {
backgroundColor: "#ffffff", // the background color of the card
borderColor: "#ffffff", // the border color of the card
titleColor: "#ffffff", // the title color
badgeColor: "#ffffff", // the background color of the badges
});
```
#### Additional context
- Please follow the structure of the code and make sure the spacing and formatting is consistent.
- The theme will not display correctly in THEMES.md until it is deployed, but you can test it locally. Your added theme will be available when your PR is merged.
- Be sure to check the previously added themes to see if a similar (or identical) theme already exists.
- This issue should remain open, please do not mark it as `fixed`.
贡献指南
调研方向
工作在 src/const/themes.ts 中,主题通过 themes.set() 函数定义。检查现有主题的结构,然后添加一个包含所选颜色的新主题对象。更新 docs/THEMES.md 以列出新主题,并在本地测试。新主题的截图应包含在拉取请求中。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- nextjs, react, tailwindcss, typescript
- 领域
- documentation, frontend
- Issue 类型
- 功能
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 活跃度
- 停滞
- 描述清晰度
- 描述清楚
- 新手友好度
- 80/100