volantis-x / hexo-theme-volantis

A Wonderful Theme for Hexo.
https://volantis.js.org
MIT License
2.07k stars 600 forks source link

【必读事项】 #814

Open CoPoKoBot opened 2 years ago

CoPoKoBot commented 2 years ago

准备工作

自建博客需要一定的相关知识,在开始前,请务必确保您会使用 markdown 语法,掌握简单的 git 知识,最最重要的是,遇到困难知道该怎么寻求解决:

推荐使用由微软开发且跨平台的免费源代码编辑器 Visual Studio Code

推荐 B站 搜索 HTML5+CSS3+js 入门 H5


快速体验

如果您没有使用过 Hexo 也不要着急,可以先通读一遍 Hexo 中文文档,要想使用地得心应手,最好参照社区团队提供的开源项目的源码进行搭建:

Demo 源码

git clone https://github.com/volantis-x/demo.git && cd demo && npm i && hexo s

官网源码

git clone --recursive https://github.com/volantis-x/community && cd community && npm i && hexo s

常见问题

如果遇到困难, 常见问题中也许有你需要的答案:

建议每次修改完成后使用 hexo clean && hexo s 先清空缓存再进行预览,浏览器建议使用访客或无痕模式。


环境配置条件

如果您从旧版本更新或着其它主题迁移,请确保环境版本不要太低,否则会产生兼容性问题。

Hexo: 5.4 ~ 6.x
hexo-cli: 4.3 ~ latest
node.js: 16.x LTS ~ latest LTS
npm: 8.x ~ latest LTS

配置和使用 volantis 5.x 或以上版本之前请确保 node.js 升级至 v16.x 或以上版本!

检查 package.json 并安装依赖

npm i hexo-renderer-ejs
npm i hexo-renderer-stylus
npm i hexo-generator-json-content

如何更新主题

更新主题请注意:

切勿在不了解更新内容的情况下更新主题,一定要先看 Release Notes

如果升级大版本,由于破坏性更改较多不会保证配置文件向下兼容, 建议重开项目,注意保留原始项目副本。

可参考:如何正确地更新主题

推荐使用 git diff 命令对比文件更新;

GitHub 也提供了在线对比的功能。


如何反馈问题

Issues 是和开发者沟通的唯一渠道,用于跟进和解决问题, 其他渠道仅用于灌水或佛系交流互动。

提问时,请尽可能详细地描述您的问题。如果不知道如何详细地描述问题,这份教程可以帮助到您:提问的智慧

Troubleshooting any problem without the error log is like driving with your eyes closed.

在没有错误日志的情况下诊断任何问题无异于闭眼开车。

自助添加示例博客

在 volantis-x/examples 仓库创建一个新 Issue 并提交,然后您的博客将显示在这里:https://volantis.js.org/examples/


开源精神

每个开源项目的背后都是一个开源社区,开源精神在于我们想实现自己的想法,把它做出来,公开出来,邀请更多的人参与进来。

开源就是由这些所铸造:一个 issue、一个 PR、一则回复、一次击掌。就是这么简单!

社区反对理所应当地索取等 “搭便车” 行为

Volantis 社区没有官方或固定开发者,只是热心网友维护罢了。


参与社区建设

如果您是开源新手想为社区贡献力量, 却不知道从哪里开始,可以阅读这份指南:如何为开源做贡献

社区建设主要包括 Issues | Discussions | 社区博客收录 | 社区文档维护 几个方面。

Volantis 社区的发展离不开团队大佬们的无私奉献和社区小伙伴们的热情互助。每一个心怀梦想、有着独特见解的朋友都可以成为团队的一员。目前 Volantis 社区正处于建设初期,我们缺少各方面的人才,如果您使用主题至少一个月且长期活跃于社区,例如:

我们非常欢迎您的加入,请在 @hexo-theme-volantis/discussions 发帖告诉我们。


一定要阅读文档

Hexo 中文文档

Volantis 社区文档

如果您使用了一些插件,例如评论系统、音乐播放器等,请阅读相关插件的文档。

魔改开发主题的朋友一定要阅读开发文档:

很多人就是不看文档.jpg


P.S. 这段文字应当放到容易看到的位置,例如 Issues 置顶