Skip to content

Commit

Permalink
docs: 优化readme以及修改协议
Browse files Browse the repository at this point in the history
  • Loading branch information
Justin3go committed Jun 2, 2024
1 parent bf58c16 commit b4b0d30
Show file tree
Hide file tree
Showing 7 changed files with 219 additions and 26 deletions.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Bug report
about: Describe the website-related issues here
title: ''
labels: bug
assignees: ''

---

### Checklist

> Please carefully check the list below and fill in `[x]` in front of the actions you have already completed.
- [ ] Confirm there are no similar issues in the repository's Issues section
- [ ] Confirm there are no similar discussions in the repository's Discussions section
- [ ] Include screenshots/video demonstration unless you think the text is clear enough

### Issue Description

> Describe your issue here in text
### Screenshots/Video Demonstration

> Optional, demonstrate your issue in detail here
### Expected Behavior

> Describe what you expect to happen here
### Additional Information

> Got more to say? Continue here~
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Feature request
about: Describe your needs here
title: ''
labels: feature request
assignees: ''

---

### Checklist

> Please carefully check the list below and fill in `[x]` in front of the actions you have already completed.
- [ ] Confirm there are no similar issues in the repository's Issues section
- [ ] Confirm there are no similar discussions in the the repository's Discussions section
- [ ] Include screenshots/video demonstration unless you think the text is clear enough

### Feature Description

> Describe your feature request here
### Online Demonstration

> Optional, provide a detailed demonstration of your request here. If there is an online link or a ready-made demo, it will help the author understand your needs more clearly.
### Additional Information

> Got more to say? Continue here~
44 changes: 23 additions & 21 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
MIT License

Copyright (c) 2024 Justin3go

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
## All files with the `.md` suffix in this repository are licensed under the following terms:

Creative Commons Attribution 4.0 International License

This work is licensed under a Creative Commons Attribution 4.0 International License.

You are free to share and adapt the material under the following terms:

- Attribution: You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.

For detailed terms and conditions, please see https://creativecommons.org/licenses/by/4.0/legalcode.

## All other files are under the MIT License

Copyright (C) <year> <copyright holders>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, see [here](https://en.wikipedia.org/wiki/MIT_License).
71 changes: 66 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,70 @@
# FAV0周刊 / FAV0 Weekly
<h4 align="right"><strong>English</strong> | <a href="./README.zh.md">简体中文</a> </h4>

记录每周所见所闻,主要关注前端、AI领域以及计算机相关内容
<div align="center">

每周六/周末更新,更新同步release一次,欢迎star/watch releases in custom关注最新周刊发布
<a href="https://fav0.com" target="blank">
<img src="https://fav0.com/favicon-512x512.png" height="200px" alt="logo" style="border-radius: 20px"/>
</a>

Recording weekly observations and experiences, primarily focusing on front-end development, AI, and computer-related content.
# "FAV0 Weekly"

Updated every Saturday/weekend, with each update synchronized with a release. Feel free to star/watch releases in custom to stay updated with the latest weekly publications.
![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)
![VitePress](https://img.shields.io/badge/VitePress-646CFF?style=for-the-badge&logo=vite&logoColor=white)
![Vue-3](https://img.shields.io/badge/Vue-3-4FC08D?style=for-the-badge&logo=vue.js&logoColor=white)
![TDesign](https://img.shields.io/badge/TDesign-0052CC?style=for-the-badge&logo=tdesign&logoColor=white)
![Cloudflare Pages](https://img.shields.io/badge/Cloudflare%20Pages-F38020?style=for-the-badge&logo=cloudflare&logoColor=white)
![Giscus](https://img.shields.io/badge/Giscus-181717?style=for-the-badge&logo=github&logoColor=white)
![Support RSS](https://img.shields.io/badge/Support%20RSS-FFA500?style=for-the-badge&logo=rss&logoColor=white)
![Support I18N](https://img.shields.io/badge/Support%20I18N-0078D4?style=for-the-badge&logo=google-translate&logoColor=white)
![SEO](https://img.shields.io/badge/SEO-4285F4?style=for-the-badge&logo=google&logoColor=white)

Record what I see and hear every week, mainly focusing on front-end, AI, and computer-related content.

Updated every Saturday/weekend, with updates synchronized with releases. Feel free to star/watch releases in custom to stay updated with the latest weekly releases.

[![changelog](https://img.shields.io/badge/changelog-→-0052CC?style=for-the-badge&logo=ReSharper&logoColor=white)](./CHANGELOG.md)


[![PR Welcome](https://img.shields.io/badge/PR-Welcome-EA4AAA?style=for-the-badge&logo=git&logoColor=white)](https://github.com/Justin3go/FAV0/pulls)
[![Request-Feature](https://img.shields.io/badge/Request-Feature-007BFF?style=for-the-badge&logo=github&logoColor=white)](https://github.com/Justin3go/FAV0/issues/new/choose)
[![Report-Bug](https://img.shields.io/badge/Report-Bug-red?style=for-the-badge&logo=github&logoColor=white)](https://github.com/Justin3go/FAV0/issues/new/choose)

![demo](./images/demo.png)

</div>

## Features


1. 🌓 Provides light and dark mode switching to adapt to different reading environments.
2. 🌍 Supports bilingual interface in Chinese and English for the convenience of users of different languages.
3. 📡 Provides RSS subscription function, supporting updates in both Chinese and English.
4. 💬 Integrated Giscus comment system for user communication and feedback.
5. 🖼️ Supports high-definition image preview for optimized visual experience.
6. 📜 Allows customization of font settings for improved reading comfort.
7. 🔍 Performs SEO optimization, including Sitemap generation, Twitter Card, and Open Graph tag support to improve search engine visibility.


## Development

```bash
git clone git@github.com:Justin3go/FAV0.git
cd FAV0

npm i -g pnpm # if needed
pnpm i
pnpm docs:dev
```
1. Modify the giscus comment configuration in `.vitepress/theme/components/Comments.vue`, specifically the `giscus` configuration;
2. Modify the sidebar configuration, RSS configuration, metadata configuration, etc., in the `utils` folder;
3. Modify the related configurations in the `config` folder, mainly title, description, etc.;
4. Change the content of the articles in the `posts/**` and `en/posts/**` directories to your own content;

## License

This repository is dual-licensed under the MIT License and CC-BY-4.0 License:

- All `.md` files are licensed under the CC-BY-4.0 License, you need to retain attribution.
- Other code files are licensed under the MIT License, you may use them freely.

For more details, please see the [LICENSE](./LICENSE) file.
70 changes: 70 additions & 0 deletions README.zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
<h4 align="right"><a href="./README.md">English</a> | <strong>简体中文</strong></h4>

<div align="center">

<a href="https://fav0.com" target="blank">
<img src="https://fav0.com/favicon-512x512.png" height="200px" alt="logo" style="border-radius: 20px"/>
</a>

# 《FAV0周刊》

![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)
![VitePress](https://img.shields.io/badge/VitePress-646CFF?style=for-the-badge&logo=vite&logoColor=white)
![Vue-3](https://img.shields.io/badge/Vue-3-4FC08D?style=for-the-badge&logo=vue.js&logoColor=white)
![TDesign](https://img.shields.io/badge/TDesign-0052CC?style=for-the-badge&logo=tdesign&logoColor=white)
![Cloudflare Pages](https://img.shields.io/badge/Cloudflare%20Pages-F38020?style=for-the-badge&logo=cloudflare&logoColor=white)
![Giscus](https://img.shields.io/badge/Giscus-181717?style=for-the-badge&logo=github&logoColor=white)
![Support RSS](https://img.shields.io/badge/Support%20RSS-FFA500?style=for-the-badge&logo=rss&logoColor=white)
![Support I18N](https://img.shields.io/badge/Support%20I18N-0078D4?style=for-the-badge&logo=google-translate&logoColor=white)
![SEO](https://img.shields.io/badge/SEO-4285F4?style=for-the-badge&logo=google&logoColor=white)

记录每周所见所闻,主要关注前端、AI领域以及计算机相关内容

每周六/周末更新,更新同步release一次,欢迎star/watch releases in custom关注最新周刊发布

[![changelog](https://img.shields.io/badge/changelog-→-0052CC?style=for-the-badge&logo=ReSharper&logoColor=white)](./CHANGELOG.md)


[![PR Welcome](https://img.shields.io/badge/PR-Welcome-EA4AAA?style=for-the-badge&logo=git&logoColor=white)](https://github.com/Justin3go/FAV0/pulls)
[![Request-Feature](https://img.shields.io/badge/Request-Feature-007BFF?style=for-the-badge&logo=github&logoColor=white)](https://github.com/Justin3go/FAV0/issues/new/choose)
[![Report-Bug](https://img.shields.io/badge/Report-Bug-red?style=for-the-badge&logo=github&logoColor=white)](https://github.com/Justin3go/FAV0/issues/new/choose)

![demo](./images/demo.png)

</div>

## 功能特性


1. 🌓 提供明暗模式切换功能,适应不同的阅读环境。
2. 🌍 支持中英双语界面,方便不同语言用户的使用。
3. 📡 提供RSS订阅功能,支持中英文内容更新推送。
4. 💬 集成Giscus评论系统,便于用户交流和反馈。
5. 🖼️ 支持高清大图预览,优化视觉体验。
6. 📜 允许自定义字体设置,提升阅读舒适度。
7. 🔍 进行SEO优化,包括Sitemap生成、Twitter Card和Open Graph标签支持,提高搜索引擎可见性。


## 开发

```bash
git clone git@github.com:Justin3go/FAV0.git
cd FAV0

npm i -g pnpm # 如果需要
pnpm i
pnpm docs:dev
```
1. 修改giscus评论配置,`.vitepress/theme/components/Comments.vue`中的`giscus`配置项;
2. 修改`utils`文件夹下的中的侧边栏配置、RSS配置、元信息配置等;
3. 修改`config`文件夹下的相关配置,主要是title、description等;
4. 修改`posts/**``en/posts/**`目录中的文章内容为自己的内容;

## 协议

本仓库采用双协议授权,即MIT协议和CC-BY-4.0协议:

- 所有`.md`文件采用CC-BY-4.0协议协议,你需要保留署名权
- 其他代码文件采用MIT协议,你可以自由使用

具体内容请查看[LICENSE](./LICENSE)文件。
Binary file added docs/public/favicon-512x512.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/demo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b4b0d30

Please sign in to comment.