# node-wiki

**Repository Path**: wxd237/node-wiki

## Basic Information

- **Project Name**: node-wiki
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2017-01-04
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

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

<img src='https://chinakids.github.io/PicturesStore/image/node-wiki/markdown-logo.png' height='120' align='left'/>
:green_book:一个基于nodejs 的 wiki 知识管理系统，文档保存使用 markdown，数据库使用 mongodb，采用多线程技术，jade 模板技术(经过了预编译)；
markdown 扩展流程图、函数、甘特图、顺序图等工具图语法；还扩展了 emoji、Art-reactor、font-awesome、ionicons等图标，极大的增强了可用性。
文档库支持关键字检索（目前只支持文件检索,后期将支持全文检索）&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;

[![npm version](https://badge.fury.io/js/npm.svg)](http://badge.fury.io/js/npm)
[![Build Status](https://travis-ci.org/chinakids/node-wiki.svg?branch=master)](https://travis-ci.org/chinakids/node-wiki)
[![dependency](https://david-dm.org/chinakids/node-wiki.svg)](https://david-dm.org/chinakids/node-wiki#info=dependencies&view=list)
[![devDependency](https://david-dm.org/chinakids/node-wiki/dev-status.svg)](https://david-dm.org/chinakids/node-wiki#info=devDependencies&view=list)

### 预览截图

![screenshot](https://github.com/chinakids/node-wiki/raw/master/screenshot.png)
![screenshot](https://github.com/chinakids/node-wiki/raw/master/screenshot2.png)

###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](https://github.com/chjj/marked)在服务器解析，扩展支持流程图，函数，甘特图，顺序图等

-   4.在线编辑器采用基于 [ace](https://github.com/ajaxorg/ace) 开发的 [markdown-plus](https://github.com/tylingsoft/markdown-plus),扩展支持 [Art-Reactor](https://github.com/chinakids/Art-Reactor) 字体，保存功能

###3.技术栈

- jade
- node
- express
- markdown
- mongodb
- worker

###4.缺陷

- 未知问题

###5.PR说明
- 欢迎各种PR
- 提交代码一定要说清楚修改哦~

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

###7.更新说明
[戳这里](./CHANGELOG.md)