3 Star 16 Fork 3

streamerzero / md

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

云文档

介绍

一个简单的 Markdown、OpenAPI 文档服务器

软件架构

  • go1.21
  • sqlite
  • vue3

编译步骤

  • 安装 go 环境
  • 安装 nodejs 环境
  • 进入目录,添加权限并执行 build.batbuild.sh
  • 编译后的可执行文件在 ./md 目录下

命令行参数

  • -p:监听端口号。默认值:9900
  • -log:日志目录,存放近 30 天的日志。默认值:./logs
  • -data:数据目录,存放数据库文件和图片。默认值:./data
  • -reg:是否允许注册(即使禁止注册,在没有任何用户的情况时仍可注册)。默认值:true
  • -pg_host:postgres 主机地址
  • -pg_port:postgres 端口
  • -pg_user:postgres 用户
  • -pg_password:postgres 密码
  • -pg_db:postgres 数据库名

数据库选择

当 postgres 相关的 5 个命令行参数全部填写时,将使用 postgres 数据库,否则使用默认的 sqlite 数据库

docker 镜像

隐含的功能按钮

  • 编辑模式:“云文档”标题
  • 收缩边栏:“云文档”标题左侧图标
  • 发布链接:文档列表蓝色倒三角
  • 公开文档列表:登录页“云文档”标题
MIT License Copyright (c) 2022 streamerzero Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

Markdown、OpenAPI文档服务器 展开 收起
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Go
1
https://gitee.com/streamerzero/md.git
git@gitee.com:streamerzero/md.git
streamerzero
md
md
master

搜索帮助