Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Freelander committed Jul 19, 2024
1 parent 85807b4 commit c97b20b
Show file tree
Hide file tree
Showing 6 changed files with 89 additions and 82 deletions.
83 changes: 42 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,71 @@
<h4 align="right"><strong>English</strong> | <a href="./README.zh.md">简体中文</a> </h4>
<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="100px" alt="logo" style="border-radius: 20px"/>
<a href="https://daily.gojun.me" target="blank">
<img src="https://cdn.jsdelivr.net/gh/freelander/oss@master/img/icon-512x512.png" height="100px" alt="logo" style="border-radius: 20px"/>
</a>

# FAV0 Weekly
# "GoJun AI Daily"

![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)
Spend 1 minute a day to get selected cutting-edge AI information.

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)
![demo](./images/demo.png)

</div>

[![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)
The content covers but is not limited to **cutting-edge AI news**, **AI tools**, **AI drawing**, **open-source projects**, and **learning tutorials**, etc.

![demo](./images/demo.png)
Updated regularly every evening, providing RSS service subscription, and you can also follow project updates via Star/Watch.

</div>
For more important information, it will be independently published on social channels for detailed introduction, and you can follow my [X (Twitter)](https://x.com/GoJun315) account.

## Features

1. 🌓 Provides light and dark mode switching to suit different reading environments.
2. 📡 Provides RSS subscription service, supporting content updates in both Chinese and English.
3. 💬 Integrated Giscus comment system for user interaction and feedback.
4. 🖼️ Supports high-definition image preview to enhance the visual experience.
5. 📜 Allows custom font settings to improve reading comfort.
6. 🔍 SEO optimization, including Sitemap generation, Twitter Card, and Open Graph tags to improve search engine visibility.

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.
## TODO

- [ ] 🌍 Support for bilingual interface in Chinese and English to facilitate use by users of different languages.
- [ ] 📧 Provide email subscription service.

## Development

This project is built based on the [FAV0](https://github.com/Justin3go/FAV0) template, using the VitePress framework.

```bash
git clone [email protected]:Justin3go/FAV0.git
cd FAV0
git clone [email protected]:Freelander/AI-Daily.git
cd AI-Daily

npm i -g pnpm # if needed
npm i -g pnpm # If necessary
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;

**Directory Description:**

Mainly look at the files in the `docs` folder.

- `.vitepress`: All configurations of the website are in this folder.
- `dist`: The output location of all resources generated by the website, also the target location for deployment.
- `config`: Configurations related to the website's title, description, icon, language, navigation, tracking code, etc.
- `theme`: Configurations related to the website's theme, page styles, and functional components (Giscus comments, appreciation), etc.
- `utils`: Configurations related to the website's sidebar, RSS, metadata, etc.
- `assets/fonts`: The font packages used by the website.
- `posts/**` and `en/posts/**`: The files in this folder are your own output content.

If you need to carry out secondary development, it is recommended to have some understanding of VitePress first. Detailed documentation is [here](https://vitepress.dev/zh/).

## License

This repository is dual-licensed under the MIT License and CC-BY-4.0 License:
This repository is dual-licensed under the MIT License and the 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.
- All `.md` files are under the CC-BY-4.0 License, and you need to retain the attribution.
- Other code files are under the MIT License, and you can freely use them.

For more details, please see the [LICENSE](./LICENSE) file.
Please refer to the [LICENSE](./LICENSE) file for specific content.
69 changes: 37 additions & 32 deletions README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,63 +2,68 @@

<div align="center">

<a href="https://fav0.com" target="blank">
<img src="https://fav0.com/favicon-512x512.png" height="100px" alt="logo" style="border-radius: 20px"/>
<a href="https://daily.gojun.me" target="blank">
<img src="https://cdn.jsdelivr.net/gh/freelander/oss@master/img/icon-512x512.png" height="100px" alt="logo" style="border-radius: 20px"/>
</a>

# FAV0周刊
# 高军 AI 日报

![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)
每天花 1 分钟时间,获取精选的前沿 AI 信息。

记录每周所见所闻,主要关注前端、AI领域以及计算机相关内容
![demo](./images/demo.png)

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

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

内容涵盖但不限于 **前沿 AI 资讯****AI 工具****AI 绘画****开源项目****学习教程** 等等。

[![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)
每天晚上定时更新,提供 RSS 服务订阅,也可通过 Star/Watch 关注项目的更新。

![demo](./images/demo.png)
对于较为重要信息,会在社交渠道独立发布进行详细介绍,可关注我的 [X(Twitter)](https://x.com/GoJun315) 账号。

</div>

## 功能特性


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

## TODO

- [ ] 🌍 支持中英双语界面,方便不同语言用户的使用。
- [ ] 📧 提供邮件订阅功能。


## 开发

本项目基于 [FAV0](https://github.com/Justin3go/FAV0) 模板构建,使用的是 VitePress 框架。

```bash
git clone [email protected]:Justin3go/FAV0.git
cd FAV0
git clone [email protected]:Freelander/AI-Daily.git
cd AI-Daily

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/**`目录中的文章内容为自己的内容;

**目录说明:**

主要看 `docs` 文件夹下的文件。

- `.vitepress`: 网站的所有配置均在该文件夹下。
- `dist`: 网站生成的所有资源输出位置,部署时也是指向这里。
- `config`: 网站的标题、描述、图标、语言、导航、跟踪代码等相关配置。
- `theme`: 网站的相关主题、页面样式以及功能组件(Giscus 评论、赞赏)等相关配置。
- `utils`: 网站的侧边栏、RSS 、元信息等相关配置。
- `assets/fonts`: 存放网站使用到的字体包。
- `posts/**``en/posts/**`: 该文件夹下的文件为你自己输出的内容。

如果你需要进行二次开发,建议先对 VitePress 有所了解,详细的文档 [在这里](https://vitepress.dev/zh/)

## 协议

Expand Down
10 changes: 5 additions & 5 deletions docs/.vitepress/config/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ import { createSideBarEN } from "../utils/createSideBar";

// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "FAV0 Weekly",
description: "FAV0 Weekly: Documenting Weekly Observations and Experiences, with a Focus on Front-end Development, AI, and Computer-related Topics",
title: "GoJun AI Daily",
description: "GoJun AI Daily: Spend 1 minute a day to get selected cutting-edge AI information.",
lang: "en-US", //语言

themeConfig: {
Expand All @@ -18,8 +18,8 @@ export default defineConfig({
sidebar: createSideBarEN(),

socialLinks: [
{ icon: 'x', link: 'https://x.com/Justin1024go' },
{ icon: 'github', link: 'https://github.com/Justin3go/FAV0' },
{ icon: 'x', link: 'https://x.com/GoJun315' },
{ icon: 'github', link: 'https://github.com/freelander' },
{
icon: {
svg: '<svg xmlns="http://www.w3.org/2000/svg" width="512" height="512" viewBox="0 0 512 512"><title>RSS</title><path d="M108.56,342.78a60.34,60.34,0,1,0,60.56,60.44A60.63,60.63,0,0,0,108.56,342.78Z"/><path d="M48,186.67v86.55c52,0,101.94,15.39,138.67,52.11s52,86.56,52,138.67h86.66C325.33,312.44,199.67,186.67,48,186.67Z"/><path d="M48,48v86.56c185.25,0,329.22,144.08,329.22,329.44H464C464,234.66,277.67,48,48,48Z"/></svg>',
Expand All @@ -29,7 +29,7 @@ export default defineConfig({
],

editLink: {
pattern: "https://github.com/Justin3go/FAV0/edit/master/docs/:path"
pattern: "https://github.com/Freelander/AI-Daily/edit/master/docs/:path",
},
},
})
2 changes: 1 addition & 1 deletion docs/.vitepress/config/zh.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { link } from 'fs';
// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "高军 AI 日报",
description: "《高军 AI 日报》:内容涵盖但不限于前沿 AI 资讯、AI 工具、AI 绘画、开源项目和学习教程等。",
description: "《高军 AI 日报》:每天花 1 分钟时间,获取精选的前沿 AI 信息。内容涵盖但不限于前沿 AI 资讯、AI 工具、AI 绘画、开源项目和学习教程等。",
lang: "zh-Hans", //语言

themeConfig: {
Expand Down
7 changes: 4 additions & 3 deletions docs/.vitepress/utils/rss.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ const hostname = "https://daily.gojun.me";
export async function createRssFileZH(config: SiteConfig) {
const feed = new Feed({
title: "高军 AI 日报",
description: "《高军 AI 日报》:内容涵盖但不限于前沿 AI 资讯、AI 工具、AI 绘画、开源项目和学习教程等。",
description: "《高军 AI 日报》:每天花 1 分钟时间,获取精选的前沿 AI 信息。内容涵盖但不限于前沿 AI 资讯、AI 工具、AI 绘画、开源项目和学习教程等。",
id: hostname,
link: hostname,
language: "zh-Hans",
Expand Down Expand Up @@ -39,6 +39,7 @@ export async function createRssFileZH(config: SiteConfig) {
author: [
{
name: "GoJun",
email: "https://daily.gojun.me",
link: "https://daily.gojun.me",
},
],
Expand All @@ -52,7 +53,7 @@ export async function createRssFileZH(config: SiteConfig) {
export async function createRssFileEN(config: SiteConfig) {
const feed = new Feed({
title: "高军 AI 日报",
description: "《高军 AI 日报》:内容涵盖但不限于前沿 AI 资讯、AI 工具、AI 绘画、开源项目和学习教程等。",
description: "《高军 AI 日报》:每天花 1 分钟时间,获取精选的前沿 AI 信息。内容涵盖但不限于前沿 AI 资讯、AI 工具、AI 绘画、开源项目和学习教程等。",
id: hostname,
link: hostname,
language: "en-US",
Expand Down Expand Up @@ -83,7 +84,7 @@ export async function createRssFileEN(config: SiteConfig) {
author: [
{
name: "GoJun",
email: "[email protected]",
email: "https://daily.gojun.me",
link: "https://daily.gojun.me",
},
],
Expand Down
Binary file modified 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 c97b20b

Please sign in to comment.