专栏首页杨建荣的学习笔记快速构建文档知识库站点

快速构建文档知识库站点

今天中午花了点时间尝试构建了一个文档知识库小站点,作为一个知识库方案落地的备选。使用的是开源项目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

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

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

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

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

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

本文分享自微信公众号 - 杨建荣的学习笔记(jianrong-notes),作者:r14笔记第48天

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2017-11-21

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 最受欢迎的微服务框架概览

    Java 构建 Spring 应用程序已经有很长一段时间了, Spring Boot 是 Spring 的一个特定版本, 它通过对配置细节的处理, 使微服务构建...

    jeanron100
  • vi的补充学习(r4笔记第25天)

    今天突然发现vi虽然用了些日子了,但是常用的一些命令之外,还是有些命令比较生疏,简单总结了一下,然后自己在vi里面编辑了一把,效果还不错。 对于大家比较熟悉且常...

    jeanron100
  • 11g rac配置scan ip(r6笔记第30天)

    如果是从10g转战11g rac就会发现很多不同之处,其中一个比较大的改变就是在11g中有了一个新特性scan,其实这是一个简称,完整的名称为:SCAN(Si...

    jeanron100
  • Linux笔记【003】| Linux系统目录结构与基本命令

    linux的文件系统是采用级层式的树状目录结构,在此结构中最上层是根目录“/”,然后在此目录下再创建其它的目录。在linux世界里。一切皆文件。

    DoubleHelix
  • Linux学习笔记(四)目录操作

    本专栏由小雨ttt创建,致力于分享学习Linux基础知识的过程。本专栏不是机械地介绍Linux指令集,而是包含了作者亲自实践的操作过程,站在一个初学者的角度理解...

    小雨编程
  • Error:Execution failed for task ':RecyclerViewDemo:mergeDebugResources'.

    问题描述:博主在导入别人一个Demo时候,在编译时编译失败,打出如下错误日志信息

    Vance大飞
  • Linux之文档与目录结构

    Linux目录结构的组织形式和Windows有很大的不同。首先Linux没有“盘(C盘、D盘、E盘)”的概念。已经建立文件系统的硬盘分区被挂载到某一个目录下,用...

    超蛋lhy
  • Linux常用命令

      本文介绍的是Linux中的常用命令用以满足日常的操作,但并非所有命令。更详细的命令烦请参考手册 http://man.linuxde.net/

    用户4919348
  • Docker系列——5.nginx的默认端口

    我们首先用whereis nginx.conf来看一下哪些目录里面有nginx.conf文件,我们看到了一共有6个目录,这里是应该分别到这六个文件里面去看一下,...

    陈琛
  • Linux 操作命令总结

    Linux使用场景:服务器操作系统(比如我正在备案中的阿里云),移动设备(安卓手机,平板),路由器(WIFI),交换机,智能家居,JAVA程序开发。

    AngelNH

扫码关注云+社区

领取腾讯云代金券