Skip to content

📗一个基于nodejs 的 wiki 知识管理系统,支持在线新建、编辑(支持自动保存)、保存、下载

License

Notifications You must be signed in to change notification settings

chinakids/node-wiki

Repository files navigation

Node Wiki - 一个 nodejs 的 markdown 在线管理和编辑工具

📗一个基于nodejs 的 wiki 知识管理系统,文档保存使用 markdown,数据库使用 mongodb,采用多线程技术,jade 模板技术(经过了预编译); markdown 扩展流程图、函数、甘特图、顺序图等工具图语法;还扩展了 emoji、Art-reactor、font-awesome、ionicons等图标,极大的增强了可用性。 文档库支持关键字检索(目前只支持文件检索,后期将支持全文检索)           

npm version Build Status dependency devDependency

预览截图

screenshot screenshot

###1.安装

#####1.1 环境配置(mac为例)

  • 1、基础环境:node、git、brew(其他平台请参照其他包管理工具)、ruby(brew依赖)

  • 2、安装mongodb并启动服务: brew install mongodb & mongod --config /etc/mongod.conf(配置文件每个人路径可能不同)

  • 3、[注意:初次部署] 请将 config/config.js中的 isFirst 改为 false

  • 4、浏览器访问对应3013端口地址设置数据库对应信息,设置完成后手动重启服务器即可使用

#####1.2 加载启动

  • 1、 git clone https://github.com/chinakids/node-wiki.git

  • 2、 npm install

  • 3、 bower install

  • 4、 多线程启动 supervisor start.coffee or pm2 start start.coffee --watch

     单线程启动 `coffee app.coffee`
    
     如使用 node启动,初次安装后需要手动重启服务器
    

###2.备注

  • 1.可能需要修改PORT,请在app.coffee中修改,数据库连接相关参数可以在欢迎页面设置,或者在 config/config.coffee 中设置

  • 2.数据库字段配置请参照schemas目录文件

  • 3.markdown 支持使用 marked在服务器解析,扩展支持流程图,函数,甘特图,顺序图等

  • 4.在线编辑器采用基于 ace 开发的 markdown-plus,扩展支持 Art-Reactor 字体,保存功能

###3.技术栈

  • jade
  • node
  • express
  • markdown
  • mongodb
  • worker

###4.缺陷

  • 未知问题

###5.PR说明

  • 欢迎各种PR
  • 提交代码一定要说清楚修改哦~

###6.下阶段开发计划

  • (紧急)将 doc 目录转为 init doc & 实体备份使用,文档内容将全部录入数据库
  • (紧急)独立出配置,首次安装建立引导页面(解决首次部署出现的种种问题)
  • 扩展多线程
  • 扩展用户中心功能
  • 增加图片上传
  • 增加超级管理员权限(方便删除)
  • 增加文档贡献者板块
  • 增加文档 TAG
  • 增加多人在线实时协作
  • 增加全文搜索功能

###7.更新说明 戳这里

About

📗一个基于nodejs 的 wiki 知识管理系统,支持在线新建、编辑(支持自动保存)、保存、下载

Resources

License

Stars

Watchers

Forks

Packages

No packages published