develop define site

适配新的站点

如何快速适配一个站点

• 以 NexusPHP 类型的站点为例；
• 在 resource/sites 目录下创建一个以网站域名为名称的目录，如 mysite.com ；
• 在该目录下创建一个 config.json 文件；
• 在 config.json 文件中输入以下内容：

  {
    "name": "MySite",
    "description": "这是一个神奇的网站",
    "url": "https://mysite.com/",
    "icon": "https://mysite.com/favicon.ico",
    "tags": ["综合", "音乐"],
    "schema": "NexusPHP",
    "host": "mysite.com",
    "collaborator": "您的大名"
  }

• 保存，然后根据 开发指引 进行打包编译就可以看到新的站点了；
• 以上为最简单的站点配置，这是在已知站点架构情况下，只需要简单的一个配置文件即可；
• 如果站点不是 NexusPHP 架构，或需要更多的配置，请继续往下看；

站点目录结构

...
├─ sites
│  ├─ mysite.com
│  │  ├─ parser
│  │  │  └─ xxx.js 
│  │  ├─ config.json
│  │  └─ xxx.js
│  └─ ... 
└─ ...

内容	必需	说明
config.json	是	站点的配置文件，详细说明参考 config.json 文件描述 。
parser	否	解析器目录，会在打包时自动将该目录下的所有 js 文件内容生成到 config.js 文件中的 parser 字段中
xxxx.js	否	页面对应的脚本文件

脚本及脚本文件定义

脚本文件及脚本片段，请使用 闭包 ，以避免 命名污染 。

如何提交一个已适配的站点？

由于本人精力及能力有限，仅能维护部分站点，如果你有更多更好玩的站点需要在助手中直接下拉选择显示，并愿意分享给其他用户使用，那么赶紧通过以下方式提交吧；（怎么听着像广告~_~）

1. 如果你有 github 账户，并知道如何使用 git ，那么可以按以下步骤进行提交

   • Fork 本项目；
   • 将 Fork 后的项目 clone 到本地；
   • 在项目的 resource\sites 目录下新建一个站点目录，如：pt.mysite.com
   • 在 pt.mysite.com 目录下新建一个 config.json 文件；
   • 如有需要，再创建特定的脚本；
   • 以上操作完成后，使用 git 将修改内容 push 到自己的 github 仓库；
   • 最后在 github 仓库中发起一个 PR(pull request) 即可；

2. 加入开发交流 QQ 群：773500545，把你的配置文件分享给我们吧；

3. 通过 该主题 留言，按格式提交已测试可用的站点信息；

PR 参考资料

• https://blog.csdn.net/vim_wj/article/details/78300239
• http://www.ruanyifeng.com/blog/2017/07/pull_request.html
• https://gist.github.com/zxhfighter/62847a087a2a8031fbdf
• https://github.com/geeeeeeeeek/git-recipes/wiki/3.3-%E5%88%9B%E5%BB%BA-Pull-Request