Raneto--支持Markdown的开源知识库

说明

个人准备建立一个小企业内部的知识库,主要的要求有如下几条:

  1. 支持Markdown进行编辑
  1. 简单,易用
  2. 可以和源码管理工具集成,便于进行知识的版本管理

经过比较和查找,没有发现完美的开源方案,但是找到了一个小而美的东东Raneto,除了第三条无法满足,其它还是不错的,于是进行了一下尝试。

Raneto

Raneto需要node.js上执行,至少4.0.0版本,不需要数据库的支持。

使用

$ git clone https://github.com/gilbitron/Raneto.git
$ cd Raneto
$ npm install
$ npm start

默认的端口为3000,可以在浏览器中访问一下,看一下效果

配置

  1. 设置自己的文档目录
# 创建自己的文档库目录,这里假设是hutou
$ mkdir hutou
$ cd hutou
# 拷贝配置文件
$ cp ../example/*.js .
$ cp ../example/*.json .
# 创建文档目录
$ mkdir content
# 创建一个演示用的文档
$ cd content
$  touch firtfile.md
$  echo "this is a test" > firtfile.md
  1. 配置文档目录
    修改raneto根目录下的package.json
  "scripts": {
    "start": "DEBUG=raneto node hutou/server.js",
    "start_win": "set DEBUG=raneto&&node hutou/server.js",
  },
  1. 再次启动服务看一下效果


    显示的内容

优化配置

目前虽然可以使用,但是不能每次修改文件都到服务器上去操作。所以去配置一下把,首先进入工作目录,修改** config.default.js**配置文件

site_title: '虎头的个人文档库',
locale: 'zh',

这些配置应该可以望文知义
这个配置文件中有用户的配置,可以自己增加用户

  credentials    : [
    {
      username : 'admin',
      password : 'password'
    },
    {
      username : 'admin2',
      password : 'password'
    }
  ],

登录之后可以编辑文档

中文搜索

这个时候的全文检索英文可用,中文是不可用的。调查了一下,有如下的方法可以解决中文搜索的问题
下面的文字摘自网上,验证可行

解决不能搜索中文的BUG
先下载一个lunr.js,链接:https://github.com/codepiano/lunr.js,解压并将文件夹命名为lunr,接下来进入node_modules
目录,找到里面的lunr重命名为lunr2(不建议删除),然后再将刚下载的lunr复制进去。还要改一个地方,进入node_modules/raneto-core/node_modules目录,刚上面那个是一样的,将这里的lunr重命名为lunr2,再将刚下载的lunr复制进去。再次重启,这里重启的时候可能会出现error,原因是node.js少了一些库,仔细看缺了哪些库,然后npm install ****

我验证了一下,应该是缺少nodejieba,在package.json中增加下面的内容

"nodejieba": "^2.0.0"

整合

raneto本身没有插件体系,如果有时间想整合一下资源将知识库的版本管理(依赖与版本管理工具)整合进来

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,088评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,715评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,361评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,099评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 60,987评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,063评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,486评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,175评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,440评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,518评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,305评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,190评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,550评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,880评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,152评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,451评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,637评论 2 335

推荐阅读更多精彩内容