快速构建文档知识库站点

简介: 今天中午花了点时间尝试构建了一个文档知识库小站点,作为一个知识库方案落地的备选。使用的是开源项目Raneto,全面支持markdown的格式。 有些同学可能对markdown的格式有些陌生,如果熟悉GitHub会发现里面大量的文件都是.md结尾的,比如readme.md文件。

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

img_e92d6b69e801ec1c43a2ab11ae83e761.jpe

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

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

img_4ef375debefd989912565bffe2c14621.jpe

这个过程可以边实现边改进,就跟我这几天和一个业内朋友讨论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来启动了。

img_564cdffb97c4b4c567bc44301c19642b.jpe

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

img_298127720286234a44e1dcdf288916c3.jpe

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

可以在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",

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

img_1f704b3ff83a640c66af66f8cdd97845.png

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

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

img_715249a78d9d28e8c0dd2f7ab066993f.png

按照这个套路继续补充即可。
目录
相关文章
|
30天前
|
人工智能 搜索推荐 开发工具
24.7K Star!用 KHOJ 打造你的AI第二大脑,自动整合和更新多源知识,轻松构建个人知识库
KHOJ 是一款开源的个人化 AI 助手,支持多源知识整合、语义搜索、个性化图像生成等功能,帮助用户高效管理知识库。
355 23
24.7K Star!用 KHOJ 打造你的AI第二大脑,自动整合和更新多源知识,轻松构建个人知识库
|
7天前
|
人工智能 资源调度 API
AnythingLLM:34K Star!一键上传文件轻松打造个人知识库,构建只属于你的AI助手,附详细部署教程
AnythingLLM 是一个全栈应用程序,能够将文档、资源转换为上下文,支持多种大语言模型和向量数据库,提供智能聊天功能。
2256 13
|
2月前
|
机器学习/深度学习 人工智能 自然语言处理
PeterCat:一键创建开源项目 AI 问答机器人,自动抓取 GitHub 仓库信息、文档和 issue 等构建知识库
PeterCat 是一款开源的智能答疑机器人,能够自动抓取 GitHub 上的文档和 issue 构建知识库,提供对话式答疑服务,帮助开发者和社区维护者高效解决技术问题。
182 7
PeterCat:一键创建开源项目 AI 问答机器人,自动抓取 GitHub 仓库信息、文档和 issue 等构建知识库
|
3月前
|
机器学习/深度学习 存储 自然语言处理
方案测评|巧用文档智能和RAG构建大语言模型知识库
本文介绍了一款基于文档智能和大语言模型(LLM)的文档解析及问答应用,旨在提升企业文档管理和信息检索效率。系统通过文档解析、知识库构建和问答服务三大模块,实现了从文档上传到智能问答的全流程自动化。
|
3月前
|
存储 数据可视化
如何高效构建团队知识库?试试看板工具
团队知识管理是提升工作效率的关键。知识管理专家Tiago Forte提出的“第二大脑”概念,强调通过收集、整理、提炼和表达四步法,将零散信息转化为系统知识。教你如何用看板工具构建团队知识库。
80 0
如何高效构建团队知识库?试试看板工具
|
4月前
|
存储 人工智能 算法
精通RAG架构:从0到1,基于LLM+RAG构建生产级企业知识库
为了帮助更多人掌握大模型技术,尼恩和他的团队编写了《LLM大模型学习圣经》系列文档,包括《从0到1吃透Transformer技术底座》、《从0到1精通RAG架构,基于LLM+RAG构建生产级企业知识库》和《从0到1吃透大模型的顶级架构》。这些文档不仅系统地讲解了大模型的核心技术,还提供了实战案例和配套视频,帮助读者快速上手。
精通RAG架构:从0到1,基于LLM+RAG构建生产级企业知识库
|
4月前
|
运维 安全 API
通义灵码知识库问答增强:知识库构建与管理指南
通义灵码能够结合企业知识库的私域数据,生成贴合企业特点的回答。充分发挥检索增强技术的优势,构建高质量的企业知识数据以及合理的知识库权限管理是必不可少的。本文将为您详细介绍如何构造与管理一个高质量的企业知识库。
通义灵码知识库问答增强:知识库构建与管理指南
|
3月前
|
存储 人工智能 自然语言处理
基于LLamaIndex构建企业级私有知识库:RAG Workflow工作流详解
【11月更文挑战第12天】随着生成式AI的快速发展,企业对智能化信息检索和生成的需求日益增加。传统的知识库系统往往局限于静态的数据存储和查询,难以满足复杂多变的业务需求。而检索增强生成(RAG, Retrieval-Augmented Generation)技术的出现,为企业级私有知识库的建设提供了新的解决方案。LLamaIndex作为专为LLMs(大型语言模型)设计的私有知识索引工具,结合RAG Workflow工作流,能够构建高效、智能的企业级私有知识库,满足企业对于知识管理和智能问答的多样化需求。
430 4
Nyx
|
4月前
|
算法
文档智能和检索增强生成构建知识库
本文介绍了文档智能(Document Mind)与检索增强生成(RAG)结合使用的原理及其优势。文档智能负责解析和结构化文档内容,RAG则利用这些数据提供准确的问答服务。部署过程中,清晰的步骤指导和详细的文档帮助快速解决问题。方案适用于企业知识库、客户支持系统等场景,但在处理大文档和复杂格式时需进一步优化。
Nyx
78 0
|
4月前
|
机器学习/深度学习 数据采集 人工智能
文档智能和检索增强生成(RAG)——构建LLM知识库
本次体验活动聚焦于文档智能与检索增强生成(RAG)结合构建的LLM知识库,重点测试了文档内容清洗、向量化、问答召回及Prompt提供上下文信息的能力。结果显示,系统在自动化处理、处理效率和准确性方面表现出色,但在特定行业术语识别、自定义向量化选项、复杂问题处理和Prompt模板丰富度等方面仍有提升空间。
191 0

热门文章

最新文章