wiki.js配置

曾经沧海难为水,除却巫山不是云。

一、 Wiki.js 安装

1.下载最新版本的Wiki.js:

Invoke-WebRequest -Uri "https://github.com/Requarks/wiki/releases/download/2.1.113/wiki-js-windows.tar.gz"  -OutFile "wiki-js.tar.gz"

2.将包解压缩到您选择的最终目的地:如 D:\wiki

3.将示例配置文件 config.sample.yml 重命名为 config.yml:

Rename-Item -Path config.sample.yml -NewName config.yml

4.使用您喜欢的文本编辑器(例如记事本)编辑配置文件,并填写数据库和端口设置(配置参考

本次操作配置如下:

端口号配置:

port: 3000

数据库配置:

db:
 type: mysql
 # PostgreSQL / MySQL / MariaDB / MS SQL Server only:
 host: #你的host(需要填写)
 port: #你的port(需要填写)
 user: #你的user(需要填写)
 pass: #你的pass(需要填写)
 db: #你的db(需要填写)
 ssl: false

git 账号配置:(http)

# ---------------------------------------------------------------------
# Git Connection Info
# ---------------------------------------------------------------------
git:
 url:#你的git仓库地址(需要填写)
 branch: master
 auth:
 # Type: basic or ssh
 type: basic
 # Only for Basic authentication:
 username:#你的git用户名(需要填写)
 password: #你的git密码(需要填写)
 # Only for SSH authentication:
 # privateKey: /etc/wiki/keys/git.pem
 sslVerify: true
 # Default email to use as commit author
 serverEmail: #你的git邮箱(需要填写)
 # Whether to use user email as author in commits
 showUserEmail: true

5.运行wiki需要node.js环境:https://nodejs.org/zh-cn/

notepad .\config.yml

6.仅适用于SQLite安装:(否则跳过此步骤)获取SQLite3的本机绑定:

npm rebuild sqlite3

7.运行Wiki.js

node server

8.等待直到邀请您打开浏览器中的设置页面。

9.完成安装向导以完成安装。

二、 Wiki.js界面管理:

wiki界面管理

1 Global

  • Navigation Menu -转到主页,浏览Wiki结构或按标签浏览的菜单。
  • Global Navigation -永久性导航菜单,显示在所有页面上。通常由重要页面或指向外部网站的链接组成。
  • Global Search -通过执行搜索快速找到页面。
  • Create New Page -创建一个新页面。
  • User Menu -用户特定的操作,例如视图配置文件,管理和注销。

2 Per Page

  • Page Actions -当前页面上的操作列表,例如“编辑”,“移动”,“删除”,“历史记录”等。
  • Breadcrumbs -当前页面的完整路径。表示文件夹结构。
  • Table of Contents -当前页面的各个部分。根据内容中的标题。
  • Page Tags -与当前页面关联的标签。通过单击标签查看相关页面。
  • Author -查看作者和页面上次修改的日期。
  • Social Links -当前页面的共享/打印链接。
  • Edit Page / Page Actions -快速访问菜单可在当前页面上编辑或执行其他操作。

三、 Wiki.js文章编写:

1. 创建新页面

为了创建新页面,请单击页面右上角的“ 新建页面”按钮;

2. 选择要为其创建页面的语言(默认选择当前语言环境)

3. 输入要创建的页面的完整路径。

  • 该路径不应包含空格(改为使用破折号),不包含句点并且应由URL安全字符组成。
  • 请勿在斜杠后面加上斜线。
  • 您无需创建文件夹。输入您要创建的完整路径,文件夹将自动创建。例如,输入universe/planets/earth自动创建Universe和Planets子文件夹。

4. 单击选择继续。以上4步如图2:

创建页面

5. 选择编辑器

创建新页面时,将出现以下对话框提示:

选择编辑器

Wiki.js根据您要编写的内容类型或只是用户首选项提供了各种编辑器。开发人员通常会使用Markdown编辑器,而非技术用户则更喜欢Visual Editor。

有关编辑器及其使用方法的完整列表,请参阅“ 编辑器”部分。

6. 输入页面数据

选择编辑器后,系统会提示您“页面数据”对话框:

页面数据

输入页面的标题描述标签

最后,单击“ 确定”关闭对话框并开始编写!

注:您以后可以通过单击页面右上角的“ 页面”按钮返回到“页面元数据”对话框。

7. 保存

直到您单击“ 创建”按钮(位于页面右上角),才会创建页面。它会被保存并呈现,之后您将自动重定向到最终结果。只需单击编辑按钮即可返回编辑!

四、 Wiki.js文件夹管理:

1.资料夹结构

Wiki.js没有传统意义上的文件夹结构。您无需创建文件夹即可创建新页面。而是直接在您选择的路径上创建页面。

例如,为了在创建一个页面/universe/planets/earth,你并不需要创建的文件夹universe,并planets在首位。他们会自动推断出来。

资料夹结构

该系统允许更大的灵活性和更少的页面之间依赖性。但是,这并不意味着您不能使用传统的文件夹系统。创建和移动页面时,文件夹结构仍然可用。唯一的区别是您不必管理文件夹,它们是从页面路径自动推断出来的。

2.面包屑

每页顶部显示的面包屑栏是根据路径自动生成的。

3.标签

标签是对页面进行分类并轻松查找相关内容的好方法。与使用复杂的文件夹系统对内容进行分类相比,它们是一种更精简的选择。标签是贴在页面上的简单标签。

4.设置标签

可以将多个标签添加到页面。

例如,对于一个关于城市页面Montreal,你可以添加标签cities,canada,north-america。这些标签随后可用于快速查找页面。通过按canada和进行浏览cities,因为页面上同时存在这两个标签,所以Montreal页面将出现在结果中。

您可以随时在页面上添加或删除更多标签。

5.浏览标签

使用按标签浏览链接(位于搜索栏旁边或在导航菜单中)可查看Wiki中所有可用标签的列表。

选择一个或多个标签以查看与所选内容匹配的页面列表。

五、 Wiki.js左标题栏link:

左标题栏link

手动输入文章地址即可生效地址。

左标题栏link地址

六、 Wiki.js文章权限管理:

1.Wiki.js的权限系统基于4个概念:

  • 团体
  • 用户数
  • 权限
  • 页面规则

一个组包含多个用户,一组权限和一个页面规则列表。

权限管理

定义了用户可以看到的内容以及他可以做什么。这可以通过使用2个概念来实现:全局权限页面规则

一个全局权限给予用户执行一个非常具体的行动的权利。例如,全局权限read:pages允许用户查看页面,而全局权限write:assets允许用户上载图像和文件。这些全局权限充当主开关,以允许或拒绝 Wiki上的特定操作。

列1:我想让用户看不到主页:点击系统阅读组,关掉这个开关。

用户组
权限开关

列2:我想让登录的用户看不到主页:在用户组内组,关掉阅读权限即可。

设置权限

虽然 global的权限是很大的一个限制用户只能执行一组特定的动作,但它缺乏的控制,其中应用这些权限。例如,您可能希望用户能够查看下方的页面,/cities但不能查看下方的页面/secret。这是页面规则起作用的地方。

2.页面规则——指定的确切位置权限。


让我们使用以下示例: 我们希望XYZ组的用户能够查看页面和查看路径完全位于的资产/cities/montreal

该页面规则将定义为:

  • 允许或拒绝: Allow
  • 权限: read:pages, read:assets
  • 规则模式: Path matches exactly...
  • 规则值: /cities/montreal
层级权限

如果将所有概念结合在一起,该小组将:

  • 有一个或多个用户
  • 具有全局权限read:pages并read:assets启用
  • 具有Allow权限的页面规则,read:pages, read:assets其中Path matches exactly.../cities/montreal

规则以什么顺序应用?

规则按照路径特异性的顺序应用。更精确的路径将始终覆盖定义不明确的路径。

例如,/geography/countries将覆盖/geography。

当两个规则具有相同的特异性时,优先级从最低到最高给出如下:

  • 路径从...开始(最低)
  • 路径以...结尾
  • 路径匹配正则表达式...
  • 路径正好... (最高)

有2个预定义且无法删除的系统组:其他规则组可以自己创建,也可以从外部身份验证系统预授权用户。

系统用户组

七、 Wiki.js git同步配置(ssh):

您必须在系统上安装Git 2.7.4或更高版本才能启用此模块!

1.生成新SSH秘钥

  ssh-keygen -t rsa -b 4096

当提示您保存生成的文件时,按Ente键。(默认在C:\Users\Joe.ssh)
将密码短语留空,然后按两次Enter键。受密码保护的密钥不起作用。

生成新SSH秘钥

在Windows上,您可以使用Git Bash或Linux的Windows子系统(WSL)发行版(例如Windows的Ubuntu)来运行上述命令。您也可以使用puttygen实用程序手动生成密钥。

2. 将密钥添加到GitHub

1.点击Settings
2.点击SSH and GPG keys
3.点击New SHH key
4.记事本打开id_rsa.pub
5.粘贴到Key点保存
6.新建成功
7.输入ssh git@github.com测试

3.. 配置Wiki.js

gitSSH配置图1

gitSSH配置图2
gitSSH配置图3
gitSSH配置图4

如何强制进行手动同步?
Git模块设置选项卡加载到管理区域(在Storage下方),滚动到页面的最底部,然后单击Force Sync操作卡上的Run按钮。

取次花丛懒回顾,半缘修道半缘君

终......

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

推荐阅读更多精彩内容