Skip to content

Commit

Permalink
Add startup and basic index
Browse files Browse the repository at this point in the history
  • Loading branch information
Freedyool committed Oct 15, 2024
1 parent 952285a commit 69ce85b
Show file tree
Hide file tree
Showing 12 changed files with 85 additions and 9 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

TG-Awesome-Blog is a VitePress-powered blog [website](http://www.yooll.ltd/).

You can share your life, share your skill, share your idea or anything you want to share.

## Documentation

Step1.
Expand Down
37 changes: 30 additions & 7 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,42 @@ export default defineConfig({

sidebar: [
{
text: 'Examples',
text: '指南',
base: '/guide/',
items: [
{ text: 'Markdown Examples', link: '/markdown-examples' },
{ text: 'Runtime API Examples', link: '/api-examples' }
{text: '快速开始', link: 'quick-start/'}
]
},
{
text: '嵌入式开发',
text: '牛马',
items: [
{ text: '基础外设', link: '/embedded/peripheral/index' },
{ text: '通信协议', link: '/embedded/protocal/index' }
{
text: '嵌入式开发',
base: '/embedded/',
link: '/',
items: [
{ text: '基础外设', link: 'peripheral/' },
{ text: '通信协议', link: 'protocal/' },
]
},
{ text: 'WEB开发', link: '/web/' },
{ text: '电子电路', link: '/electronic/' }
]
},
{
text: '泼猴',
items: [
{ text: '旅行', link: '/traveling/' },
{ text: '厨艺', link: '/cooking/' },
{ text: '摄影', link: '/photography/' }
]
},
{
text: '小西天',
items: [
{ text: '搞钱', link: '/business/' },
{ text: '瞎搞', link: '/misc/' }
]

}
],

Expand Down
7 changes: 7 additions & 0 deletions docs/business/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# 搞钱

## 兼职

## 副业

## 创业
1 change: 1 addition & 0 deletions docs/cooking/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# 厨艺
1 change: 1 addition & 0 deletions docs/electronic/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# 电子电路
2 changes: 1 addition & 1 deletion docs/embedded/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 嵌入式开发应知应会
# 嵌入式开发

## 嵌入式外设

Expand Down
2 changes: 1 addition & 1 deletion docs/embedded/peripheral/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 嵌入式外设
# 基础外设

在嵌入式系统领域,常见的外设(或外部设备)通常用于与微控制器或处理器进行交互,以满足不同的输入、输出、存储、通信等功能需求。以下是嵌入式系统中一些常见的外设:

Expand Down
32 changes: 32 additions & 0 deletions docs/guide/quick-start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# 快速开始

## EDIT/CLONE/FORK

你可以有多种方式来上传你的文章,但它们在原理上都包含了:编辑->提交->部署(已实现自动化)这三个步骤,你可以根据具体的使用场景来决定使用什么方式。

### Use github.dev (推荐)

### Clone then Push

### Fork then Request PR

## 如何编辑

假设你有一篇md文档需要上传,你可以这么做:

1. 在 /docs/** 下依据文件夹找到你的内容所属类别,如果没有就新建一个
2. 将你的文章放入对应目录中
3. 编辑 /dosc/.vitepress/config.mts 添加你的文章的访问路径到 sideBar 中
4. 提交一个 commit 然后推送到 main 分支
5. 等待 github action 的自动部署

如果你想在推送之前预览一下你的编辑,你可以:

1. clone 代码到你的本地 然后安装一个 node 环境 然后执行 npm ci 然后执行 npm run docs:dev
2. 如果你使用 github.dev 你就可以在 github codespaces 完成上面的过程(推荐)
3. 之后你就可以在命令中直接 Ctrl+左键 访问到 http://localhost:5173/ 来检查你的效果

## 参考

- [vitepress指南](https://vitejs.cn/vitepress/guide/what-is-vitepress)
- [vitepress参考](https://vitejs.cn/vitepress/reference/site-config)
1 change: 1 addition & 0 deletions docs/misc/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# 杂谈
1 change: 1 addition & 0 deletions docs/photography/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# 摄影
1 change: 1 addition & 0 deletions docs/traveling/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# 旅行
7 changes: 7 additions & 0 deletions docs/web/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# WEB开发

## 前端

## 后端

## 数据库

0 comments on commit 69ce85b

Please sign in to comment.