courses icon indicating copy to clipboard operation
courses copied to clipboard

一起来打造掘金社区的技术教程

稀土教程 beta

掘金社区共创教程,欢迎大家一起添加学习内容,共同进步!

网站还未正式发布,测试地址:https://xitu.github.io/courses/

如何共建内容?

fork本项目,在src/docs目录下创建Markdown或者MDX文档,然后提交PR即可!

如何一起改进平台

项目基于docz (虽然docz仍有一些坑,但是足够强大,且扩展性良好)

可以在src/components目录下添加React组件,用于你的文章中。

如果能一起优化doczgatsby就更好了,现在在dev环境中编译调试有较多的问题,希望大家一起帮忙逐一解决。

希望这个开源项目能打造出一个面向技术初学者的伟大的文档平台!

TODO

  • [ ] 制定mdx文件名与name的建议规范,写一个检查menu下的文件中是否存在配置name重复的脚本,如果有重复,解决冲突并生成displayName
  • [ ] 待进一步优化Gatsby的编译性能

License

Shield: CC BY-NC-SA 4.0

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

CC BY-NC-SA 4.0