Skip to content

Commit 6dcff4c

Browse files
committed
feat(docs): 删除过时的文档示例并更新首页内容
- 移除不再使用的 API 示例文档和 Markdown 示例文档 - 更新首页功能介绍,简化描述,提升可读性 - 调整样式以优化用户体验
1 parent 8897b3b commit 6dcff4c

File tree

6 files changed

+303
-188
lines changed

6 files changed

+303
-188
lines changed
Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,29 @@
1-
import { defineConfig } from 'vitepress'
1+
import { defineConfig } from 'vitepress';
22

33
// https://vitepress.dev/reference/site-config
44
export default defineConfig({
5-
title: "Simple-Notation Docs",
6-
description: "Simple-Notation Docs",
5+
title: '简音创作教程',
6+
description: '简音创作网站使用教程,及SimpleNotation库使用教程',
77
themeConfig: {
88
// https://vitepress.dev/reference/default-theme-config
99
nav: [
10-
{ text: 'Home', link: '/' },
11-
{ text: 'Examples', link: '/markdown-examples' }
10+
{ text: '首页', link: '/' },
11+
{ text: '网站教程', link: '/site-tutorial/module' },
1212
],
1313

1414
sidebar: [
1515
{
16-
text: 'Examples',
16+
text: '网站教程',
1717
items: [
18-
{ text: 'Markdown Examples', link: '/markdown-examples' },
19-
{ text: 'Runtime API Examples', link: '/api-examples' }
20-
]
21-
}
18+
{ text: '模块介绍', link: '/site-tutorial/module' },
19+
{ text: '语法教程', link: '/site-tutorial/syntax' },
20+
],
21+
},
2222
],
2323

2424
socialLinks: [
25-
{ icon: 'github', link: 'https://github.com/vuejs/vitepress' }
26-
]
27-
}
28-
})
25+
{ icon: 'github', link: 'https://github.com/Encaik/simple-notation' },
26+
{ icon: 'npm', link: 'https://www.npmjs.com/package/simple-notation' },
27+
],
28+
},
29+
});

packages/docs/api-examples.md

Lines changed: 0 additions & 49 deletions
This file was deleted.

packages/docs/index.md

Lines changed: 67 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -16,90 +16,117 @@ hero:
1616

1717
features:
1818
- icon: 🎼
19-
title: 一键成谱,创作零门槛
19+
title: 一键成谱
2020
details: |
21-
- **文本转乐谱**: 输入文本,秒转专业乐谱,告别复杂操作。
22-
- **多格式支持**: 自由选择生成简谱、六线谱(吉他/尤克里里)。
23-
- **随心定制**: 和弦显示、谱面宽高、边距等细节由你掌控。
21+
- 文本秒转乐谱,创作零门槛
22+
- 支持简谱/六线谱,随心定制
2423
- icon: 🎹
25-
title: 听见创作,看见演奏
24+
title: 沉浸式演奏
2625
details: |
27-
- **沉浸式播放**: 同步显示钢琴、吉他、口琴动态面板,直观学习。
28-
- **音色与面板联动**: 切换音色,乐器面板自动匹配更新。
29-
- **精准播放控制**: 支持移调、分轨播放与变速,是排练学习的助手。
26+
- 动态乐器面板,音色联动
27+
- 分轨、变速、移调,精准控制
3028
- icon: 🛠️
31-
title: 高效创作工坊
29+
title: 智能编辑
3230
details: |
33-
- **流畅在线编辑器**: 轻松编辑音符、休止符、连音线等。
34-
- **文件导入辅助**: 上传MIDI/MP3作为参考,辅助手动扒谱或改编。
35-
- **音高检测与K歌**: 开启麦克风实时检测音高,K歌模式带音高反馈。
31+
- 流畅编辑音符、连音线等
32+
- 支持MIDI/MP3导入,音高检测
3633
- icon: 📚
37-
title: 精选乐谱库
38-
details: 内置精选实用乐谱(经典片段、练习曲等),点击即可编辑、播放、学习,助力日常练习与灵感激发。
34+
title: 乐谱库
35+
details: |
36+
- 内置精选乐谱,点击即用
37+
- 一键编辑、播放、学习
3938
- icon: 📥
40-
title: 自由流转,轻松输出
39+
title: 输出无忧
4140
details: |
42-
- **无缝衔接**: 支持乐谱导入/导出,方便协作。
43-
- **高清打印**: 一键高清打印,随时分享纸质乐谱。
41+
- 导入导出,协作无缝
42+
- 高清打印,随时分享
4443
---
4544

4645
<style>
46+
/* audience-section 区块整体渐变背景和居中 */
4747
.audience-section {
48-
max-width: 960px;
49-
margin: 40px auto;
48+
max-width: 100vw;
49+
margin: 48px 0 0 0;
50+
padding: 48px 0 56px 0;
5051
text-align: center;
5152
}
53+
.audience-section h2 {
54+
font-size: 2.2rem;
55+
font-weight: 700;
56+
margin-bottom: 32px;
57+
letter-spacing: 1px;
58+
}
5259
.audience-grid {
5360
display: flex;
5461
flex-wrap: wrap;
5562
justify-content: center;
56-
gap: 16px;
57-
margin-top: 24px;
63+
gap: 28px;
64+
margin-top: 0;
5865
}
5966
.audience-card {
60-
background-color: var(--vp-c-bg-soft);
61-
border: 1px solid var(--vp-c-bg-soft);
62-
border-radius: 12px;
63-
padding: 16px;
64-
min-width: 180px;
65-
flex: 1;
66-
max-width: 220px;
67-
transition: border-color 0.25s, background-color 0.25s;
67+
background: #fff;
68+
border: 2px solid #7b5aff;
69+
border-radius: 18px;
70+
padding: 28px 18px 22px 18px;
71+
min-width: 200px;
72+
max-width: 240px;
73+
flex: 1 1 200px;
74+
box-shadow: 0 2px 12px 0 rgba(123,90,255,0.08);
75+
transition: transform 0.2s, box-shadow 0.2s, border-color 0.2s;
76+
position: relative;
77+
overflow: hidden;
6878
}
6979
.audience-card:hover {
70-
border-color: var(--vp-c-brand);
80+
transform: translateY(-8px) scale(1.04);
81+
box-shadow: 0 8px 32px 0 rgba(255,107,61,0.18);
82+
border-color: #ff6b3d;
83+
}
84+
.audience-card .icon {
85+
font-size: 2.2rem;
86+
margin-bottom: 10px;
87+
display: block;
7188
}
7289
.audience-card h4 {
73-
font-size: 16px;
74-
font-weight: 600;
75-
margin: 0 0 4px 0;
76-
color: var(--vp-c-brand-dark);
90+
font-size: 1.1rem;
91+
font-weight: 700;
92+
margin: 0 0 6px 0;
93+
color: #7b5aff;
7794
}
7895
.audience-card p {
79-
font-size: 14px;
96+
font-size: 1rem;
8097
margin: 0;
81-
color: var(--vp-c-text-2);
98+
color: #444;
99+
letter-spacing: 0.2px;
100+
}
101+
@media (max-width: 900px) {
102+
.audience-grid { flex-direction: column; align-items: center; }
103+
.audience-card { max-width: 320px; min-width: 0; }
82104
}
83105
</style>
84106

107+
<!-- audience-section 用于突出目标用户,采用渐变背景和主题色卡片 -->
85108
<div class="audience-section">
86109
<h2>✨ 为热爱音乐的你而生</h2>
87110
<div class="audience-grid">
88111
<div class="audience-card">
112+
<span class="icon">💡</span>
89113
<h4>创作者</h4>
90-
<p>快速捕捉灵感,高效编辑试听。</p>
114+
<p>灵感速记,乐谱即刻成型。</p>
91115
</div>
92116
<div class="audience-card">
117+
<span class="icon">📖</span>
93118
<h4>学习者</h4>
94-
<p>看谱+听音+学指法,三位一体突破瓶颈!</p>
119+
<p>看谱、听音、学指法,三合一突破瓶颈。</p>
95120
</div>
96121
<div class="audience-card">
122+
<span class="icon">👩‍🏫</span>
97123
<h4>教师</h4>
98-
<p>便捷生成教学素材,直观演示演奏技法。</p>
124+
<p>高效生成教学素材,直观演示技法。</p>
99125
</div>
100126
<div class="audience-card">
127+
<span class="icon">🎤</span>
101128
<h4>爱好者</h4>
102-
<p>玩转乐谱、K歌练唱,探索音乐乐趣!</p>
129+
<p>K歌练唱,玩转乐谱,探索音乐乐趣!</p>
103130
</div>
104131
</div>
105132
</div>

packages/docs/markdown-examples.md

Lines changed: 0 additions & 85 deletions
This file was deleted.
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
outline: deep
3+
---
4+
5+
# 模块介绍
6+
7+
本页面将介绍简音创作网站的主要功能模块,帮助用户快速了解各部分的用途和使用方法。
8+
9+
## 1. 乐谱编辑模块
10+
11+
- 支持简谱、五线谱等多种记谱方式。
12+
- 提供可视化编辑界面,支持拖拽、快捷键操作。
13+
- 可导入/导出多种格式(如 JSON、ABC 等)。
14+
15+
## 2. 乐器选择与音色模块
16+
17+
- 内置钢琴、吉他、手风琴等多种乐器音色。
18+
- 支持试听、切换乐器,适配不同演奏需求。
19+
- 音频采样高质量,支持多种格式(mp3、ogg、wav)。
20+
21+
## 3. 音频播放与导出模块
22+
23+
- 支持乐谱实时播放,自动滚动。
24+
- 可导出音频文件,便于分享和二次创作。
25+
- 支持节奏、速度、音量等参数调整。
26+
27+
## 4. 歌词与注释编辑模块
28+
29+
- 支持歌词同步编辑,自动对齐音符。
30+
- 可添加注释、标记,便于教学和交流。
31+
32+
## 5. 其他辅助功能
33+
34+
- 支持多平台浏览器访问,响应式设计。
35+
- 内置示例乐谱和教程,便于新手上手。
36+
- 支持自定义主题、快捷键等个性化设置。
37+
38+
## 典型使用流程
39+
40+
1. 选择或新建乐谱,编辑音符与歌词。
41+
2. 选择乐器音色,试听效果。
42+
3. 保存或导出乐谱/音频文件。
43+
4. 可将作品分享到社区或导入到其他音乐软件。
44+
45+
## 相关链接
46+
47+
- [语法教程](/site-tutorial/syntax)
48+
- [SimpleNotation 库文档](https://www.npmjs.com/package/simple-notation)
49+
- [项目源码](https://github.com/Encaik/simple-notation)

0 commit comments

Comments
 (0)