From cdf644caba303574ea9ec9456f2bdcac76021d45 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BA=95=E5=B1=82=E7=94=A8=E6=88=B7?= Date: Tue, 28 Jun 2022 17:50:15 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=E9=85=8D=E7=BD=AE=E6=96=87?= =?UTF-8?q?=E4=BB=B6=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README_EN.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 106 insertions(+) diff --git a/README.md b/README.md index 98a449e..33937dd 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,59 @@ - [x] 移动端适配 * [ ] 还没想好呢 +### 配置 + +本项目采用 `json` 文件来配置站点内容，该配置不受版本更新影响，可将自定义配置写入 `setting.json` 以更改页面内容 + +
+配置说明 + +```json +{ + "title": "网页标题", + "description": "网页简短介绍", + "keywords": "网页关键词", + "author": "网页作者", + "logo_img": "Logo图片路径", + "logo_text_1": "域名前缀", + "logo_text_2": "域名后缀", + "des_title": [ + "Hello World !", //站点介绍标题 + "一个建立于 21 世纪的小站，存活于互联网的边缘" //站点介绍内容 + ], + "des_title_change": [ + "Oops !", //站点介绍标题点击后文字 + "哎呀，这都被你发现了 ( 再点击一次可关闭 )" //站点介绍内容点击后文字 + ], + "github": "imsyy", //Github 用户名 + "qq": "1539250352", //QQ + "email": "one@imsyy.top", //Email电子邮件 + "telegram": "bottom_user", //Telegram 用户名 + "twitter": "iimmsyy", //Twitter用户名 + "weather_api": "https://www.yiketianqi.com", //天气 API + "link_1": [ + "https://blog.imsyy.top/", //链接地址 + "fa-solid fa-blog", //图标类名 + "博客" //链接文字 + ], + "link_2": [ + "https://drive.imsyy.top/", + "fa-solid fa-cloud", + "网盘" + ], + "wallpaper_api": [ + [ + "每日一图", //壁纸设置项名称 + "https://api.dujin.org/bing/1920.php" //壁纸图片链接 + ] + ], + "Copyright_year": "2020", //站点起始年份 + "Copyright_text": "無名" //版权 +} +``` + +
+ ### 音乐 >本项目采用了基于 `MetingJS` 的 `Aplayer` 音乐播放器，可实现快速自定义歌单 diff --git a/README_EN.md b/README_EN.md index a2048ac..f5bae98 100644 --- a/README_EN.md +++ b/README_EN.md @@ -28,6 +28,59 @@ Simple little homepage, had enough of the original one and made a new one - [x] Mobile adaptation * [ ] Haven't thought about it yet +### Configuration + +This project uses `json` file to configure the site content, the configuration is not affected by version updates, you can write custom configuration to `setting.json` to change the page content + +
+Configuration instructions + +```json +{ + "title": "Title of the page", + "description": "Short description of the page", + "keywords": "Keyword(s)", + "author": "author of the page", + "logo_img": "Logo image path", + "logo_text_1": "Domain Prefix", + "logo_text_2": "Domain_suffix", + "des_title": [ + "Hello World !" , // site description title + "A small site built in the 21st century, living on the edge of the Internet" // site description content + ], + "des_title_change": [ + "Oops !" , //text after clicking on the site's title + "Oops, you found this ( click once more to close )" //text after click on site content + ], + "github": "imsyy", //Github username + "qq": "1539250352", //QQ + "email": "one@imsyy.top", //email email + "telegram": "bottom_user", //Telegram user name + "twitter": "iimmsyy", //Twitter username + "weather_api": "https://www.yiketianqi.com", //Weather API + "link_1": [ + "https://blog.imsyy.top/", //link_address + "fa-solid fa-blog", //icon class name + "blog" //link text + ], + "link_2": [ + "https://drive.imsyy.top/", + "fa-solid fa-cloud", + "netdisk" + ], + "wallpaper_api": [ + [ + "picture of the day", //name of wallpaper setting item + "https://api.dujin.org/bing/1920.php" //link to wallpaper image + ] + ], + "Copyright_year": "2020", //site start year + "Copyright_text": "No name" //Copyright +} +``` + +
+ ### Music >This project uses the `Aplayer` music player based on `MetingJS` for quick song list customization