wiki.js 是一款免费、开源的 wiki 软件,可帮助你创建和管理自己的 wiki。它具有直观的用户界面、强大的编辑功能和可扩展的功能,使其成为个人、团队和企业创建和共享文档的绝佳选择。
安装和配置
- 安装:wiki.js 可以在大多数主流操作系统上安装,包括 Linux、Windows和 macOS。有关特定安装说明,请参阅官方文档。
- 配置:安装后,你需要配置 Wiki 的基本设置,例如站点标题、描述和管理员密码。
创建和编辑页面
- 创建新页面:单击左上角的“新建页面”按钮。
- 编辑页面:单击页面标题或工具栏上的“编辑”按钮。
- 使用富文本编辑器:wiki.js 提供了一个功能丰富的富文本编辑器,使你可以轻松地创建和格式化内容。
- 使用标记语言:你还可以使用 Markdown 或 WikiCreole 等标记语言来编写内容,这提供了更高级的格式化选项。
管理页面和结构
- 组织页面:你可以使用层次结构组织页面,创建嵌套页面和子页面。
- 链接页面:使用内置链接工具在页面之间创建链接。
- 重定向页面:你可以创建一个重定向页面,将用户从一个页面重定向到另一个页面。
- 管理文件:wiki.js允许你上传和管理文件,例如图片、文档和媒体。
搜索和导航
- 搜索栏:使用右上角的搜索栏快速查找页面。
- 侧边栏导航:侧边栏提供对页面和文件结构的快速访问。
- 页面列表:单击侧边栏上的“页面”选项卡查看所有页面的列表。
协作与权限
- 协作编辑:多位用户可以同时编辑同一个页面,wiki.js 会自动合并更改。
- 权限控制:你可以控制谁可以创建、编辑和查看页面。
- 版本控制:wiki.js 跟踪页面的每个更改,使你可以恢复到以前的版本。
扩展功能
- 插件:wiki.js 提供了一个广泛的插件生态系统,可扩展其功能,例如日历、地图和数学方程编辑器。
- 主题:你可以下载和安装不同的主题来自定义wiki的外观。
- API:wiki.js 提供了一个 API,允许你与外部应用程序和脚本集成。
总结
wiki.js是一款功能强大、易于使用的wiki软件,非常适合个人、团队和企业创建和管理文档、共享知识和协作项目。其直观的用户界面、丰富的编辑功能、可扩展的功能和协作工具使其成为一个全面的wiki解决方案。
Wiki.js 是一款免费且开源的 wiki 软件,它允许你轻松地创建、管理和编辑你的 wiki 网站。以下指南将深入介绍如何在你的服务器上设置和使用 Wiki.js:
安装 Wiki.js
- 确保你的服务器满足要求:Node.js 版本 ≥ 14,MongoDB ≥ v5.0。
- 克隆 Wiki.js 代码仓库:
git clone https://github.com/Requarks/wiki
- 进入克隆的文件夹:
cd wiki
- 安装依赖项:
npm install
配置 Wiki.js
- 创建配置文件:
cp .env.example .env
- 编辑
.env
文件并根据你的需求进行配置,例如:PORT
: 服务器端口DB_HOST
: MongoDB 主机DB_PORT
: MongoDB 端口DB_NAME
: MongoDB 数据库名称SECRET
: 用于加密 cookie 的密钥
- 如果需要,还可以配置额外的选项,请参阅 Wiki.js 文档 获取更多详细信息。
启动 Wiki.js
- 运行以下命令启动 Wiki.js:
npm start
- 浏览器中访问你的服务器地址(例如:
http://localhost:3000
) - 如果安装成功,你将看到 Wiki.js 登录页面。
使用 Wiki.js
- 创建你的第一个页面:点击顶部导航栏中的“创建”按钮,输入页面标题和内容。
- 编辑页面:将鼠标悬停在页面标题上并点击“编辑”图标。
- 创建层次结构:使用 “#” 符号创建标题,例如 “# 一级标题”,在标题下方创建子页面。
- 格式化文本:Wiki.js 支持 Markdown 格式,允许你轻松地格式化文本。
- 管理用户:点击右上角的用户图标,创建和管理用户,并分配角色和权限。
- 设置插件:Wiki.js 提供了一系列插件,可以扩展其功能,例如:
embed
: 嵌入视频、图像和代码片段math
: 渲染数学方程syntax-highlight
: 高亮语法代码social-share
: 添加社交分享按钮
- 定制主题:你可以定制 Wiki.js 的主题以匹配你的品牌或喜好。
Wiki.js 的优点
- 易于使用:直观的界面使初学者和专家都能轻松地使用。
- 可定制:可以通过插件和主题广泛定制,以满足特定需求。
- 协作性:允许多个用户同时编辑和管理 wiki。
- 版本控制:自动保存页面历史记录,以便恢复意外更改。
- 搜索:提供强大的搜索功能,可以快速查找信息。
常见问题
-
如何解决启动 Wiki.js 时遇到的错误?
- 检查你是否满足所有要求,例如 Node.js 和 MongoDB 的版本。
- 检查
.env
文件中的配置是否正确。 - 查看 Wiki.js 的 故障排除指南 获取更详细的说明。
-
如何重置管理员密码?
- 删除数据库中
users
集合中的所有文档。 - 重新启动 Wiki.js,系统将创建具有默认密码的新管理员用户。
- 删除数据库中
-
如何设置 SSL 证书?
- 获取 SSL 证书并将其存储在
certs
文件夹中。 - 编辑
.env
文件并设置以下配置:HTTPS=true
SSL_KEY=/path/to/cert.key
SSL_CERT=/path/to/cert.crt
- 获取 SSL 证书并将其存储在
结论
Wiki.js 是一款功能强大且易于使用的 wiki 软件,非常适合创建和管理你的 wiki 网站。通过遵循本指南,你可以快速地启动和运行 Wiki.js,并享受它的众多好处。
简介
wiki.js是一个开源的、基于浏览器的wiki软件平台。它旨在提供一个灵活且用户友好的知识管理和协作环境。
使用步骤
1. 安装
- 使用Docker或手动安装wiki.js。
- 创建一个新的数据库。
- 配置wiki.js设置。
2. 创建一个Wiki
- 单击“新建”按钮创建新wiki。
- 为wiki指定名称和描述。
3. 添加页面和内容
- 在wiki中单击“创建新页面”按钮。
- 为页面输入标题和内容。
- 使用Markdown语法进行格式化。
4. 组织页面
- 使用树形结构组织页面和子页面。
- 创建页面别名和重定向以简化导航。
- 利用标签对相关页面进行分类。
5. 协作
- 邀请其他用户加入wiki并授予他们适当的权限。
- 使用评论和讨论功能进行协作。
- 跟踪页面历史记录和版本控制。
6. 管理用户和权限
- 创建用户帐户并管理他们的角色和权限。
- 分配页面级权限以控制访问和编辑。
- 设置访问控制列表(ACL)以实现更精细的控制。
7. 搜索和过滤
- 使用搜索栏查找特定的页面或内容。
- 使用过滤器按创建日期、标签或作者缩小搜索范围。
8. 扩展功能
- 安装插件以添加额外的功能,例如表格、图表和自动链接。
- 使用API与其他应用程序集成。
高级特性
1. 版本控制
wiki.js维护页面历史记录,允许用户查看和恢复以前的版本。
2. 附件管理
用户可以上传和管理文件、图像和视频附件。
3. 模板和布局
wiki.js提供模板和布局选项,允许用户定制wiki的外观和功能。
4. 国际化
wiki.js支持多种语言,用户可以翻译页面和界面。
总结
wiki.js是一个功能丰富的wiki软件平台,可满足各种知识管理和协作需求。其用户友好的界面、协作功能和高级特性使其非常适合个人、团队和组织。无论是创建文档、管理知识库还是促进协作,wiki.js都是一个可靠且强大的解决方案。