快速构建文档知识库站点

今天中午花了点时间尝试构建了一个文档知识库小站点,作为一个知识库方案落地的备选。使用的是开源项目Raneto,全面支持markdown的格式。

有些同学可能对markdown的格式有些陌生,如果熟悉GitHub会发现里面大量的文件都是.md结尾的,比如readme.md文件。

markdown支持的格式还是很丰富的,而且语法相当简洁。相比于html的标签更加轻量级。GitHub上有个项目就做RADME,就是示例怎么去写markdown格式的文件。

这个过程可以边实现边改进,就跟我这几天和一个业内朋友讨论SQL审核时我说,功能优先,界面丑点没关系,我们能忍。这是一个0-1,1-90的问题,你得现有,然后再在这个基础上谈优化。

构建Raneto项目的步骤很简单,大概得花个十多分钟。

首先需要从GitHub上下载整个项目。

git clone https://github.com/gilbitron/Raneto

因为Raneto是基于NodeJS的项目,所以你得包装安装了NodeJS,可以参考链接:

https://nodejs.org/zh-cn/download/

比如我下载了一个略旧的版本,最新的是8.9.1

node-v7.6.0-linux-x64.tar

使用node -v来查看版本,如果没有问题,证明这个基础的安装就可以了。

接下来需要的就是npm了,这是管理JS包的工具。

有了node,就会自带。使用npm -v也可以查看npm的版本。

然后我们到Raneto的目录下,使用npm install来完成基本的安装,这个过程会持续一些时间,因为要下载一些相关的包,在根目录所在路径的目录.npm下,会下载大概50M左右的相关包。

这个部分完成之后,就可以使用npm start来启动了。

打开页面http://localhost:3000即可看到内容。整体看起来还不错。

当然这个是一个样例目录,我们需要在这个基础上来定制修改,完成自己的基本需求。

可以在Raneto目录下创建一个新的目录,可以理解是一个新的项目,比如jeanron100

可以把同级目录example下的*.js和*.json文件都拷贝过来复用

然后创建一个content目录,作为显示的内容主体,这个目录和web项目里面的webroot,webapp等差不多。然后我们可以创建一个测试文件index.md

输入一句话作为测试:

# cat index.md

this is a test

修改jeanron100目录下的config.default.js文件,添加文件的标题和语言(默认是英文)

site_title: 'DBA文档库',

locale: 'zh',

然后在Raneto的目录下修改入口的配置文件package.json

修改下面的这一句为项目jeanron100

"s": {

"start": "DEBUG=raneto node jeanron100/server.js",

重新启动,就可以看到新的页面了。

稍后比如我们继续补充,可以添加很多的目录,比如在content下面添加多个目录,一个根目录是a,然后下面有一系列的目录和文件。

刷新一下就能看到效果了。

按照这个套路继续补充即可。

时间: 2024-10-25 01:34:30

快速构建文档知识库站点的相关文章

文档知识库规划图谱

今天在规划文档知识库的内容.想了很多的方式,也咨询了不少圈内好友. 有了一个基本的思路,我的想法是构建的知识库目录尽可能全面,重合度低,而且能够有很多落到实处. 我构想了几个大的方向,比如技术架构和选型,流程规范,日常管理保障,自动化平台建设,性能优化保障,文化建设,知识分享. 直接上图,也希望大家能够提出更多的改进建议.  

Word 2013中如何快速打印文档

在Word2013文档中,用户可以按默认设置快速打印文档.这个操作就跟在Word2003中直接单击常用工具栏中的"打印"按钮一样,可以在不进行任何设置的情况下完整打印一份当前文档.在Word2013中快速打印文档的步骤如下所述: 第1步,打开Word2013文档窗口,单击"自定义快速访问工具栏"按钮,并在打开的列表中选中"快速打印"选项,如图2013080710所示. 图2013080710 选中"快速打印"选项 第2步,在&

如何巧用分割快速实现文档的“一变多”

  将一篇各章节具有明显标识的文章分成多个文件,你是不是还在反复使用复制.粘贴和另存为的方法呢?其实,利用EmEditor的标签配合文档分割功能,可快速实现文档的"一变多".如某文档结构如图1所示,现在需要将此文档按照形如"[28/04/2015 12:32] Title1"的内容为界(其他类型的文件也可以按照以下的方式进行,只要找到各章节的明显分割出,如小说的"第X章".多行空格等),分割为多个文档保存. 1. 设置书签 在EmEditor中载

Word快速删除文档中多余的空行

  1:把你复制好的文件,在word里面打开,在"点击编辑"--"替换" 文档中多余的空行-word删除多余空行"> 2:这里删除行的是,把原有多出的行,替换掉的. 跟着小编所给的步骤,一部一部的慢慢来.这就是小编给大家带来的快速删除文档中多余的空行步骤,希望能帮到大家.

Win 7快速定位照片、快速查找文档等

  微软Windows 7系统库快速定位照片.快速查找文档.自动显示日期使用方法. 分类筛选直观显示让库更好用 库功能是Windows 7系统最大的亮点之一,它彻底改变了我们的文件管理方式,从死板的文件夹方式变得更为灵活和方便.但随着库里的文件.文件夹数量越来越庞大,从库中直观地选择需要的文件就开始变得困难起来,其实,利用好库的排列方式就可以很好地解决这个问题,下面就用一些实例来看看怎么快速找出库中需要的文件. 点击超级任务栏上的资源管理器打开库,可以看到在资源管理器菜单栏"更改您的视图&quo

使用 Hyde 快速构建轻量级的静态站点

概述 在 Web 开发早期,大多数网页只是某个服务器上文件系统中的一个页面.随着 Web 的日益成 熟,借助动态站点.电子商务.大规模发布和 Web 上的应用程序,从使用简单文件转换到使用复杂的 Web 内 容管理系统 (CMS) 和发布工具也变得越来越普遍.每天都有数以千计的站点在以下平台上运行: IBM WebSphere 其他 Java 框架或 .NET 其他流行的可供替换的 Web 发布框架,比如 Ruby on Rails 和 Django 面向社区的 CMS,比如 WordPress

WPS文字教程:快速提取文档中的图片

朋友,当你-- 看到别人文章中精美的图片,想把它收藏起来-- 想把自己的图文并茂的作品发布到论坛或博客中-- 你都需要将文档中的图片提取出来,作为一个个文件保存! 最简洁快速的办法是--? 将文件另存为--网页文件(*html,*htm).这样一来,文件中的全部图片就会保存在同一个文件夹内. 本例中,为便于查找,将<WPS助我写博客>另存在桌面上: 打开桌面上的"WPS助我写博客1.files"文件夹,就可以发现所有的图片乖乖地躺在里面等候您的召唤!

Word2013中快速打印文档的方法

  第1步,打开Word2013文档窗口,单击"自定义快速访问工具栏"按钮,并在打开的列表中选中"快速打印"选项,如图1所示. 图1 选中"快速打印"选项 第2步,在"快速访问工具栏"单击"打印"按钮,Word2010将使用默认的打印机完整打印一份当前文档,用户无法对打印选项做任何设置,如图2所示. 图2 单击"快速打印"按钮

数据库 PSU,SPU(CPU),Bundle Patches 和 Patchsets 补丁号码快速参考 (文档 ID 1922396.1)

文档内容   用途   详细信息   Patchsets   PSU, SPU(CPU), Bundle Patches   12.1.0.1   11.2.0.4   11.2.0.3   11.2.0.2   11.2.0.1   11.1.0.7   11.1.0.6   10.2.0.5   10.2.0.4   10.2.0.3   10.2.0.2   10.2.0.1   10.1.0.5   10.1.0.4   10.1.0.3   10.1.0.2   9.2.0.8   9