Skip to content

Commit

Permalink
docs: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Justin3go committed Jul 28, 2024
1 parent 824e06f commit 6de4429
Show file tree
Hide file tree
Showing 5 changed files with 48 additions and 50 deletions.
55 changes: 27 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<h4 align="right"><strong>English</strong> | <a href="./README.zh.md">简体中文</a> | <a href="./README.ja.md">日本語</a></h4>
<h4 align="right"><strong>English</strong> | <a href="./README.zh.md">简体中文</a> </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://justin3go.com" target="blank">
<img src="https://justin3go.com/ava.jpg" height="100px" alt="logo" style="border-radius: 20px"/>
</a>

# FAV0 Weekly
# Justin3go Blog

![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)
Expand All @@ -18,53 +18,52 @@
![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.
A fully-featured, modern, and elegantly simple static blog based on VitePress; it mainly records ✍️ my blog and notes.

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.
Releases will be made once every weekend/Saturday if there are updates. Article publications and website modifications will be recorded in the releases. Feel free to star/watch (custom->release) to stay updated on the latest news~

[![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)
[![PR Welcome](https://img.shields.io/badge/PR-Welcome-EA4AAA?style=for-the-badge&logo=git&logoColor=white)](https://github.com/Justin3go/justin3go.com/pulls)
[![Request-Feature](https://img.shields.io/badge/Request-Feature-007BFF?style=for-the-badge&logo=github&logoColor=white)](https://github.com/Justin3go/justin3go.com/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/justin3go.com/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.

1. 🌓 Provides a dark/light mode toggle for different reading environments.
2. 📖 Supports blog pagination, summaries, and tags for convenient user navigation.
3. 🌍 Supports a bilingual interface in Chinese and English for users of different languages.
4. 📡 Offers RSS subscription functionality, supporting content updates in both Chinese and English.
5. 💬 Integrates the Giscus commenting system for user interaction and feedback.
6. 🖼️ Supports high-definition image previews for an optimized visual experience.
7. 📜 Allows custom font settings to enhance reading comfort.
8. 🔍 Implements SEO optimizations, including Sitemap generation and support for Twitter Cards and Open Graph tags to improve search engine visibility.

## Development

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

npm i -g pnpm # if needed
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;
1. Modify the Giscus comment configuration in the `giscus` settings of `.vitepress/theme/components/Comments.vue`;
2. Adjust the sidebar configuration, RSS settings, metadata configuration, etc., in the `utils` folder;
3. Change the relevant configurations in the `config` folder, mainly the title, description, and GA settings in the head;
4. Replace the content in the `posts/**` and `en/posts/**` directories with your own content;

## License

This repository is dual-licensed under the MIT License and CC-BY-4.0 License:
This repository is licensed under a dual license, namely 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 licensed under CC-BY-4.0, and you must retain attribution rights.
- Other code files are licensed under the MIT License, and you can use them freely.

For more details, please see the [LICENSE](./LICENSE) file.
For specific details, please refer to the [LICENSE](./LICENSE) file.
37 changes: 18 additions & 19 deletions README.zh.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<h4 align="right"><a href="./README.md">English</a> | <strong>简体中文</strong> | <a href="./README.ja.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://justin3go.com" target="blank">
<img src="https://justin3go.com/ava.jpg" height="100px" alt="logo" style="border-radius: 20px"/>
</a>

# 《FAV0周刊》
# Justin3go Blog

![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)
Expand All @@ -18,37 +18,36 @@
![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领域以及计算机相关内容
一款功能齐全的、现代化的、简洁优雅的静态博客,基于vitepress;主要记录✍️我的博客、笔记。

每周六/周末更新,更新同步release一次,欢迎star/watch releases in custom关注最新周刊发布
每周末/周六如有更新release一次,文章发布以及网站修改会记录在release中,欢迎star/watch(custom->release)关注最新动态~

[![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)
[![PR Welcome](https://img.shields.io/badge/PR-Welcome-EA4AAA?style=for-the-badge&logo=git&logoColor=white)](https://github.com/Justin3go/justin3go.com/pulls)
[![Request-Feature](https://img.shields.io/badge/Request-Feature-007BFF?style=for-the-badge&logo=github&logoColor=white)](https://github.com/Justin3go/justin3go.com/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/justin3go.com/issues/new/choose)

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

</div>

## 功能特性


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

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

## 开发

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

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

## 协议
Expand Down
3 changes: 2 additions & 1 deletion docs/.vitepress/theme/components/Comment.vue
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ import Giscus from "@giscus/vue";
const route = useRoute();
const { isDark, frontmatter } = useData();
const term = computed(() => route.path.slice(-3));
// 保证中英文路径显示同一个评论
const term = computed(() => route.path.startsWith("/en") ? route.path.slice(3) : route.path);
const theme = computed(() => (isDark.value ? "noborder_dark" : "noborder_light"));
const lang = computed(() => route.path.startsWith("/en") ? 'en' : 'zh-Hans');
Expand Down
1 change: 0 additions & 1 deletion docs/about.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
# https://vitepress.dev/reference/default-theme-home-page
layout: doc
editLink: false
lastUpdated: false
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "justin3go.com",
"version": "2.0.0",
"version": "1.0.0",
"description": "坚持深耕技术领域的T型前端程序员, 关注独立开发与AI,喜欢Vuejs、Nestjs, 还会点Python、搜索引擎、NLP、Web3、后端",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit 6de4429

Please sign in to comment.