Edoc-简单的MD文档工具

简介

基于svelte开发的文档工具，只需要编写markdown文件，即可生成在线文档。

项目

https://gitee.com/suruibuas/edoc
https://github.com/suruibuas/edoc

原站

http://edoc.eui6.com/

安装

// 拉取代码
git clone https://gitee.com/suruibuas/edoc.git
// 进入目录
cd edoc
// 安装依赖
npm i

启动本地开发

npm run dev

生产构建

npm run build

其它

直接下载仓库
cd进解压目录

pnpm i

pnpm dev

和上面的安装是一样的

修改

因为是国产开源的 所以里面提示什么的全是汉语 能看懂汉语的基本都能折腾吧 作者写的很清晰明了了

src/config.js设置

各种站点设置 网站名称 导航菜单的各种名称路由 右上角的外链 中间的大标题 口号 描述简介 首页预览图开关 底部友链 版权和备案信息

src/components/Footer.svelte页脚

可以看一下 没啥要改的 需要改的都在上面设置中就能改

src/components/Header.svelte

右上角链接的文字 和站点LOGO

src/router/doc.js 文章路由

src/views/Home.svelte

修改首页那三个块和文字 项目预览 和那两个跳转的大按钮

有点

只需要丢文章进去 或丢文件夹进去MD目录 不需要打理路由 基本全自动

吐槽

1. 把首页预览关掉 那个黑白模式也没了
2. 代码块不换行 也没有滑动条
3. 没有标配搜索功能 得自己加 好像静态的这些文档啥的都不带搜索也不知道为些啥
4. 想试试多级目录 套了两个文件夹进去 本地就一直在加载中了 部署完再看看
5. 在线构建一堆问题 折腾半天还是没成功 主要就卡在/\这两个杠的路径上
6. 存在二级目录 本地都没法构建 二级目录名称会直接跟在一级目录后面 没有/
7. 侧栏目录树 竟然忽略了##

没有部署在线构建 只把dist丢了上去 看看效果