开源知识库平台Raneto

在这里插入图片描述

什么是 Raneto ?

Raneto 是一个开源知识库平台,它使用静态 Markdown 文件来支持您的知识库。

官方提供了 doc & demo 网站,即是帮助文档,也是个 demo,地址:https://docs.raneto.com

准备

项目使用config.js 做为设置文件,该文件的源码地址:https://raw.githubusercontent.com/ryanlelek/Raneto/master/config/config.js

  • 记得用 UTF-8 编码格式保存,因为你可能会用中文的标题等;
  • 每次修改之后,要重启容器才能生效;

首先有几处需要修改的地方:

  1. 修改站点标题

例如:将site_title: 'Raneto Docs'改成 site_title: '老苏的测试站点'

  1. 修改用户名和密码

默认内置了 2 个用户,建议修改

  credentials: [{username: 'admin',password: 'password',},{username: 'admin2',password: 'password',},],
  1. 修改语言,使之支持中文

默认是英文

  locale: 'en',// Support search with extra languagessearchExtraLanguages: ['ru'],

老苏改为了

  locale: 'zh',// Support search with extra languagessearchExtraLanguages: ['zh'],

修改后的文件,老苏放在了 https://github.com/wbsu2003/synology/blob/main/Raneto/config.js,方便你需要的时候做对照

安装

在群晖上以 Docker 方式安装。

在注册表中搜索 raneto ,下翻找到 raneto/raneto,版本选择 latest

docker 文件夹中,创建一个新文件夹 raneto,并在其中建两个子文件夹 configcontent,将前面准备的 config.js 放入 config 目录

文件夹装载路径说明
docker/raneto/config/opt/raneto/config存放设置文件
docker/raneto/content/opt/raneto/content存放 markdown文件

端口

本地端口不冲突就行,不确定的话可以用命令查一下

# 查看端口占用
netstat -tunlp | grep 端口号
本地端口容器端口
38443000

命令行安装

如果你熟悉命令行,可能用 docker cli 更快捷

# 新建文件夹 raneto 和 子目录
mkdir -p /volume1/docker/raneto/{config,content/{pages,static}}# 进入 raneto 目录
cd /volume1/docker/raneto# 运行容器
docker run -d \--restart unless-stopped \--name raneto \-p 3844:3000 \-v $(pwd)/config:/opt/raneto/config \-v $(pwd)/content:/opt/raneto/content \raneto/raneto:latest

也可以用 docker-compose 安装,将下面的内容保存为 docker-compose.yml 文件

version: "2.1"services:raneto:image: raneto/raneto:latestcontainer_name: ranetorestart: unless-stoppedports:- 3844:3000volumes:- ./config:/opt/raneto/config- ./content:/opt/raneto/content

然后执行下面的命令

# 新建文件夹 raneto 和 子目录
mkdir -p /volume1/docker/raneto/{config,content/{pages,static}}# 进入 raneto 目录
cd /volume1/docker/raneto# 将 docker-compose.yml 放入当前目录# 一键启动
docker-compose up -d

运行

在浏览器中输入 http://群晖IP:3844 就能看到主界面

login

用户密码正确的话,会显示

登录成功后的主界面其实还是一样的,只是在进入页面后,会有编辑权限

接下来在 /content/pages 中放入 markdown 文件或者目录即可

页面排序

每个页面可以包含有关该页面的可选元数据。

  • Title - 此变量将覆盖基于文件名的标题;
  • Description - 此变量将提供要搜索的描述;
  • Sort - 此变量将影响类别内页面的排序;
  • ShowOnHome - 可选。如果为 false,页面将不会在主页上列出。可以通过更改config.show_on_home_default调整默认行为;
  • Modified - 此变量将覆盖基于文件名的修改日期。

下面是一个示例的 markdown 文件,文件名为 根目录2.md

---
Title: 根目录第二篇
Sort: 1
---根目录第二篇,但显示为第一位;

所以显示效果是下面👇这样的

目录排序

目录显示出来实际上就是分类,你可以在当前文件夹中增加一个名称为 meta 的文件

  • Title - 此变量将覆盖基于文件夹名称的标题;
  • Sort - 此变量将影响分类(目录)的排序;
  • ShowOnHome - 可选。如果为 false,将不会显示在主页上。可以通过更改config.show_on_home_default 调整默认行为;
  • Description - 可选。该变量将提供在模板中使用的变量,例如在主页中,以增强和阐明类别的内容。

下面是一个示例的 meta 文件

Title: 安装使用
Sort: 1

如果不需要变更分类名称,可以更简单的提供一个 sort 文件,文件中只要写排序就行

2

展示效果

重启容器后的显示效果

点开进入

登录之后有编辑权限

注意事项

但凡文件中有中文的,一定要用 UTF-8 编码格式保存,否则页面上就会出现乱码,切记切记~

参考文档

ryanlelek/Raneto: Markdown powered Knowledgebase Wiki for Node.js
地址:https://github.com/ryanlelek/Raneto

Raneto - Markdown Knowledgebase for Node.js
地址:https://raneto.com/

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/73431.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

Android之 Canvas绘制

一 Canvas介绍 1.1 Canvas 是绘制图形的重要类之一,它可以在 View 或 SurfaceView 上绘制各种图形和文本. 1.2 要创建 Canvas,首先需要有一个 View 或 SurfaceView 对象,在 View 或 SurfaceView 的绘制方法中,可以通过 Canvas 的…

Git的一些常用概念与操作方法分享

Git是一个版本控制系统,它可以记录代码的变化历史并允许多个开发者同时对同一代码库进行开发。以下是Git的基本概念和使用方式: 仓库(Repository)- 保存代码的地方。Git仓库包含了所有的版本历史记录、代码以及其他相关文件。 分…

【元宇宙】临界质量,元宇宙的关键要素

考虑到电气化和移动技术的普及过程,我们可以自信地说,元宇宙不会突然到来。同时,也不会有明确的“元宇宙之前”( beforeMetaverse )和“元宇宙之后”( afterMetaverse )阶段一它们只是对应着生活发生改变的历史时期。一…

使用ADB命令查询Android设备的安卓版本信息

确保你已经安装了ADB并将其添加到系统的路径中。 连接你的Android设备到计算机,并确保启用了开发者选项和USB调试模式。你可以在设备的设置中找到这些选项。 打开终端(命令提示符或终端窗口)。 运行以下ADB命令来获取Android设备的安卓版本…

华为云云耀云服务器L实例评测|部署spring项目端口开放问题的解决 服务器项目环境搭建MySQL,Redis,Minio...指南

目录 引出书接上回,部署spring项目,端口访问失败最后排查结果反馈 尝试的几种解决方案【未成功】1.指定tomcat启动ipv4端口2.添加开放端口规则保存规则防火墙相关命令记录 最终成功解决【成功!】用firewall成功了问题来了,如果这里…

Linux系统离线安装RabbitMQ

安装rabbitmq 1、下载安装包 首先进入官网进行安装包的下载,在下载时一定要注意erlong版本和rabbitmq-server版本匹配 rabbitmq版本对应关系:传送门 Erlong下载地址:传送门 rabbitmq-server下载地址:传送门 socat 不同版本 centos7:传送门 cent…

OJ练习第166题——课程表(拓扑排序问题)

课程表 力扣链接:207. 课程表 题目描述 你这个学期必须选修 numCourses 门课程,记为 0 到 numCourses - 1 。 在选修某些课程之前需要一些先修课程。 先修课程按数组 prerequisites 给出,其中 prerequisites[i] [ai, bi] ,表…

2023数学建模国赛B题完整论文来啦!(含一二问求解代码及三四问仿真模拟代码)

大家好呀,从昨天发布赛题一直到现在,总算完成了全国大学生数学建模竞赛B题完整的成品论文。 本论文可以保证原创,保证高质量。绝不是随便引用一大堆模型和代码复制粘贴进来完全没有应用糊弄人的垃圾半成品论文。 说实话团队通宵一直到现在做…

MyBatis的缓存

文章目录 前言一、MyBatis的缓存1.MyBatis的一级缓存2.MyBatis的二级缓存3.二级缓存的相关配置4.MyBatis缓存查询的顺序5.整合第三方缓存EHCache(了解)添加依赖各个jar包的功能创建EHCache的配置文件ehcache.xml设置二级缓存的类型加入logback日志EHCach…

CG MAGIC进行实体渲染后!分析渲染器CR和VR的区别之处!

新手小白来说,如何选择渲染器,都会提出疑问? 渲染效果图究竟用CR渲染器还是VR渲染器呢? 今天,CG MAGIC小编通过一个真实的项目场景,实例渲染之后,CR渲染器和VR渲染器区别有哪几点? 1…

flatten-maven-plugin使用

这篇文章主要介绍了flatten-maven-plugin使用,本文通过示例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下 − 目录 一、简介 1.1 作用1.2 goal介绍二、使用总结 一、简介 1.1 作用 将pom工程父子pom的版…

每天几道面试题(第一天)

目录 第一幕 、第一场)某大厦楼下大门前第二场)电梯中第三场)公司前台 友情提醒 背面试题很枯燥,加入一些戏剧场景故事人物来加深记忆。PS:点击文章目录可直接跳转到文章指定位置。 第一幕 、 第一场)某大厦楼下大门…

Eviews用向量自回归模型VAR实证分析公路交通通车里程与经济发展GDP协整关系时间序列数据和脉冲响应可视化...

全文下载链接:http://tecdat.cn/?p27784 河源市是国务院1988年1月7日批准设立的地级市,为了深入研究河源市公路交通与经济发展的关系,本文选取了1988-2014年河源市建市以来24年的地区生产总值(GDP)和公路通…

Java jvm 内存溢出分析

1.如何分析jvm内存溢出呢 我们经常用visualVm监控Jvm的内存,cpu,线程的使用情况,通常可以根据内存不断增长来判断内存是否存在不释放。但是我们不可能时时盯着去看,这里涉及jvm堆内存配置,堆内存参数配置和调优会在其…

rk3399 android以太网和wifi共存

Android 9 1.修改 frameworks/base/core/java/android/net/NetworkFactory.java evalRequest 方法 注释两行 private void evalRequest(NetworkRequestInfo n) {if (VDBG) log("evalRequest");if (n.requested false && n.score < mScore &&n…

uniapp中UView中 u-form表单在v-for循环下如何进行表单校验

1、数据data格式 注&#xff1a;rule绑定的tableFromRule中要和表单tableFrom下面放置一个同名数组&#xff0c;确保u-form能找到 tableFrom: {tableData: [//数据详情列表]},tableFromRule: {//校验tableData: [//数据详情列表]},formRules:{localation:[{required: true,mes…

深入剖析HTTP和HTTPS代理在爬虫中的应用价值

在当今信息时代&#xff0c;数据是无处不在且极其宝贵的资源。对于从互联网上获取大量结构化或非结构化数据的需求而言&#xff0c;网络爬虫成为一种强有力的工具。然而&#xff0c;在实际操作过程中&#xff0c;我们常常会面临许多挑战和限制。   其中一个主要问题就是目标网…

微信小程序开发---网络数据请求

目录 一、小程序中网络数据请求的限制 二、发起get请求 三、发起post请求 一、小程序中网络数据请求的限制 具体有两个限制&#xff1a; &#xff08;1&#xff09;只能请求HTTPS类型的接口 &#xff08;2&#xff09;必须将接口的域名添加到信任列表中&#xff0c;在调试的时…

k8s 入门到实战--部署应用到 k8s

k8s 入门到实战 01.png 本文提供视频版&#xff1a; 背景 最近这这段时间更新了一些 k8s 相关的博客和视频&#xff0c;也收到了一些反馈&#xff1b;大概分为这几类&#xff1a; 公司已经经历过服务化改造了&#xff0c;但还未接触过云原生。公司部分应用进行了云原生改造&…

第 2 章 线性表 (线性表的静态单链表存储结构(一个数组只生成一个静态链表)实现)

1. 背景说明 A { c, b, e, g, f, d }B { a, b, n, f } 2. 示例代码 1) status.h /* DataStructure 预定义常量和类型头文件 */#ifndef STATUS_H #define STATUS_H#define CHECK_RET(ret) if (ret ! RET_OK) { \printf("FuncName: %-15s Line: %-5d ErrorCode: %-3d\n&…