Skip to content

TalexDreamSoul/germ-mc-docs

Repository files navigation

Germ MC - Docs

无懈可击的 MC 拓展框架 # Wiki

本项目是未完成品,BUG较多,功能未完善!

项目背景

本来是想给萌芽做一个非常牛逼的维基,然后自己也没写过类似的,就想要写一个,结果受限于时间和个人技术,无耐舍弃。然后因为部分UI还是勉强看得过去,所以分享一下,拿给需要的人。 SEO 得自己做,有了大概框架,搬个 SSR 应该不难,就是很麻烦,细节繁琐。 之前跟萌芽作者询问了一下 SEO 的事情,感觉没什么必要,再加上当时 Nuxt.js (for vue3) 还在孵化,就用 vite 做了一下。

项目技术

主要是 Vite + Vue3 + Element-Plus 然后部分封装了一点

详细的可以看一下 package.json

项目预览

在线预览 (随时可能会没掉,有时间补图)

安装运行

    npm i -g pnpm
    pnpm i
    pnpm run dev

已有功能

  • 完整的文档列表
  • 文档收缩
  • 部分适配
  • 主题颜色(暗黑,明亮)
  • 完整的文档功能
  • UI好看(雾)
  • 侧边栏收缩展开
  • 侧边栏广告
  • 比较高级的搜索系统
  • 集成 JavaDoc
  • 集成 论坛/后台
  • 比较高级的关于页面
  • ... 自行探索

功能设想

  • 文档编辑历史,类似于提 pr一样编辑
  • 文档大纲
  • 文档浏览量
  • 文档搜索
  • 文档切换
  • 文档分享
  • 后台文档编辑
  • ...

支持一下

觉得可以,可以点个 star 支持一下。

Releases

No releases published

Packages

No packages published

Languages