amWiki 安装与使用指南

amWiki 安装与使用指南

amWikiamWiki 是一款由 JS 开发、依赖 Atom 或 Nodejs-Npm 的 Markdown 轻量级前端化开源文库系统项目地址:https://gitcode.com/gh_mirrors/am/amWiki

1. 项目介绍

amWiki 是一个由 JavaScript 开发，依赖 Atom 编辑器或 Node.js 的 Markdown 轻量化前端开源文库系统。它简化了个人和团队文档库的建立过程，不需要数据库，只需支持 HTTP 静态访问的空间就能运行。主要特点包括：

• Markdown 语法：文档系统基于 Markdown 语法，易于编辑和阅读。
• 无需数据库：文档以 .md 格式存储在本地文件中。
• 一键创建文库：可快速创建新的文库，自动更新导航目录。
• 多级目录：支持多级别的分类结构。
• 图片粘贴：支持截图直接粘贴到本地并插入文档。

2. 项目快速启动

安装要求

确保已安装以下软件：

• Atom（可选，仅用于在 Atom 中直接使用）
• Node.js 和 npm

安装 amWiki

首先，克隆项目仓库到本地：

git clone https://github.com/TevinLi/amWiki.git
cd amWiki

接着，安装必要的依赖：

npm install

创建文库

在 config.json 文件中编辑配置，如需更改库名、作者等信息。完成后，执行：

./bin/init.sh <库名称>

例如:

./bin/init.sh MyFirstWiki

这将在 library 目录下创建一个新的文库。

启动本地服务器

使用以下命令启动本地静态服务器：

./bin/server.sh

现在你可以访问 http://localhost:3000 来查看你的文库。

创建文档

在 library/<库名称> 目录下，创建 .md 文件，用 Markdown 语法编写内容。

touch library/MyFirstWiki/Introduction.md

编辑该文件，然后使用浏览器刷新来查看变更。

3. 应用案例与最佳实践

• 知识管理：个人或团队可以利用 amWiki 组织学习笔记、技术文档和知识体系。
• API 文档：开发者可以创建 API 文档，便于团队成员查阅和更新。
• 项目文档：项目组可以在文库中存放项目说明、设计文档和进度报告。

最佳实践建议：

1. 将文库目录备份到云同步服务，保障数据安全。
2. 定期更新 config.json，以保持文库的整洁和更新。
3. 使用统一的 Markdown 样式和命名规则，提高文档一致性。

4. 典型生态项目

amWiki 可与其他项目结合，如：

• Git：与 Git 集成，进行版本控制和协作。
• Gulp 或 Webpack：自动化构建流程，优化资源加载速度。
• Jekyll 或 Hugo：如果你希望将 amWiki 部署到静态托管服务，这些静态站点生成器可以帮助你。

请参阅amWiki 官方文档以获取更详细的配置和扩展信息。

---

本文档遵循 MIT 许可协议。

amWikiamWiki 是一款由 JS 开发、依赖 Atom 或 Nodejs-Npm 的 Markdown 轻量级前端化开源文库系统项目地址:https://gitcode.com/gh_mirrors/am/amWiki