麻烦点个star,目前该项目处于起步阶段,非常希望大家可以一起帮助完善内容,做成软工同学们一个交流学习的平台
首先不得不提的一点是开源精神!!!
起初只是我和易俊泉学长把自己的笔记放在 CSDN 上让学弟学妹们参考,这种算是比较简单快捷的方式,但是由于 CSDN 并不是定制的笔记网站,因此相对来说内容会很乱,导致找资料什么的都不方便,泉佬也将自己的笔记开源到了 Github 上,但是并没有制作一个阅读的网站,只能是 clone 后在本地看,也不是很方便。
我在 CSDN 发博客时候就在考虑要不要自己做个笔记网站来分享一些笔记内容,但是由于当时各种事情太忙加上我也比较懒,一直搁置到现在,最近中期答辩完了闲下来,然后慢慢开始准备这个项目,同时也是找到了一些学弟学妹也有相同的想法,希望将自己为考试准备的一些东西分享出来,毕业后就没有什么作用了,不如帮助学弟学妹们学习更简单一些,节省出一些时间去做自己想做的事情,同时避免一些重复劳动。
---- by 霍嘉
这个项目中主要包含有三个部分:
也可以将本项目拉取到本地运行,本项目使用 docsify 编译,因此本地需有 nodejs 环境,建议下载 LTS 版本,下载后全局安装 docsify 依赖,然后运行即可。
git clone https://github.com/Hydrion-Qlz/XJTUSE-GUIDE.git
cd xjtuse-guide
npm i docsify-cli -g
docsify serve .
通过集成 docsify 多样化的插件,文档支持 Latex 公式, pdf文件渲染
该项目由西安交通大学软件学院同学维护
提交细节请参考How to Contribute
如果是软工的同学,建议还是自己搞懂如何提 pr、如何使用 Github,算是一种必须掌握的技能