一般来讲,详细的wiki可以让用户更方便地了解和学习你的插件。
我注意到很多人喜欢使用gitbook制作自己的插件wiki。
gitbook一般来讲够用了,但它存在一个大问题:国内连接不稳定,经常进不去或卡掉。
而Github Pages一般不会遇到这种事。
本教程致力于让你畅通无阻地使用Docusaurus制作一个插件wiki,通过Github Pages免费构建网站,同时可以通过Github Actions,在提交内容后自动更新网站内容,自动将网站制作为pdf文件,并自动release。
当然,一个Docusaurus的教程,肯定要用Docusaurus写,一个Github Pages的教程,肯定要通过Github Pages免费构建一个网站供大家阅读。
项目开源地址:
https://github.com/Neige7/Wiki-Template
教程网页:
https://neige7.github.io/Wiki-Template/
我注意到很多人喜欢使用gitbook制作自己的插件wiki。
gitbook一般来讲够用了,但它存在一个大问题:国内连接不稳定,经常进不去或卡掉。
而Github Pages一般不会遇到这种事。
本教程致力于让你畅通无阻地使用Docusaurus制作一个插件wiki,通过Github Pages免费构建网站,同时可以通过Github Actions,在提交内容后自动更新网站内容,自动将网站制作为pdf文件,并自动release。
当然,一个Docusaurus的教程,肯定要用Docusaurus写,一个Github Pages的教程,肯定要通过Github Pages免费构建一个网站供大家阅读。
项目开源地址:
https://github.com/Neige7/Wiki-Template
教程网页:
https://neige7.github.io/Wiki-Template/