Lyrics Book

贡献指南

一些在为此项目贡献前所需要知道的事项

添加歌手 / 艺术家

创建歌手文件夹

content/docs目录下创建一个文件夹,并将文件夹命名为对应的英文名称,名称应小写,并使用连词符-间隔

如:“陈升” 命名为 “bobby-chen”

添加歌手到索引列表中

content/docs/meta.json中将歌手的英文名称添加到列表的后面,名称应与第一步中的文件夹名称保持一致

创建index.mdx

在歌手文件夹下创建文件index.mdx,然后写入以下内容,注意将框中的内容修改为对应的名称

这个文件的功能是在歌手页面中将该歌手的所有歌曲列出

index.mdx
---
title: 新歌手
description: New Singer's Lyrics
---
 
// 你可以选择在这里写一些歌手的简介,也可以直接放空
 
import { LyricsList } from '@/components/lyrics-list';
 
<LyricsList artist="new-singer"/>

添加专辑和歌词

下面将以李志的《阿兰》(收录于专辑《被禁忌的游戏》)为例,介绍如何添加专辑和歌词

创建专辑文件夹

在对应歌手的文件夹下创建专辑文件夹,文件夹名称应使用专辑的英文名,名称应小写,并使用连词符-间隔,可包含数字

如:“被禁忌的游戏” 命名为 “forbidden-game”

创建meta.json

在专辑文件夹下创建文件meta.json,然后写入以下内容,将专辑的中文名称或正式名称填入title

meta.json
{
    "title": "被禁忌的游戏"
}

添加歌词

在专辑文件夹下创建MDX文件用于保存歌词,注意歌词文件应使用数字命名(建议使用专辑内序号命名),文件结构如下

1.mdx
2.mdx
3.mdx
4.mdx
5.mdx
6.mdx
7.mdx
8.mdx
9.mdx
meta.json

接下来,向MDX文件中写入歌词

1.mdx
---
title: 阿兰
description: 李志 - 被禁忌的游戏
---
 
阿兰你在哪啊
 
你是否找到了他
 
阿兰你现在的生活是否和我一样
 
阿兰你还记得吗 我那时的模样
 
阿兰你长大了是否还有人爱啊
 
阿兰我们的生活像条颠簸飘离的船
 
阿兰我们的生活像条颠簸飘离的船
每一行歌词间必须包含一个空行或<br />进行换行,否则歌词在网页中显示时不会换行

提交Pull Request

请参考Github官方文档 Creating a Pull Request from a Fork,fork本项目并提交Pull Request

On this page