NoteWidget 安装和配置指南

NoteWidget 安装和配置指南

NoteWidget Markdown add-in for Microsoft Office OneNote 项目地址: https://gitcode.com/gh_mirrors/no/NoteWidget

1. 项目基础介绍

NoteWidget 是一个为 Microsoft Office OneNote 开发的 Markdown 插件。它允许用户在 OneNote 中查看和编辑 Markdown 格式的内容，并支持语法高亮、主题切换、Mermaid 图表等功能。该项目的主要编程语言是 C#。

2. 项目使用的关键技术和框架

• Markdig: 一个强大的 Markdown 解析器，支持 CommonMark 和 GitHub 风格的 Markdown。
• Mermaid: 用于生成流程图、序列图、甘特图等图表的 JavaScript 库。
• OneNote API: 用于与 OneNote 进行交互的 Microsoft Office API。

3. 项目安装和配置的准备工作

在开始安装之前，请确保您的开发环境满足以下要求：

• Microsoft Visual Studio: 推荐使用最新版本的 Visual Studio 进行开发和调试。
• .NET Framework: 确保您的系统上安装了 .NET Framework 4.5 或更高版本。
• OneNote: 您需要安装 Microsoft Office OneNote 2013 或更高版本。

4. 详细的安装步骤

4.1 克隆项目仓库

首先，您需要从 GitHub 上克隆 NoteWidget 项目到本地。打开命令行工具，输入以下命令：

git clone https://github.com/efreykongcn/NoteWidget.git

4.2 打开项目

克隆完成后，使用 Visual Studio 打开项目文件夹中的 NoteWidget.sln 解决方案文件。

4.3 安装依赖项

在 Visual Studio 中，右键点击解决方案资源管理器中的项目名称，选择“管理 NuGet 包”。在弹出的窗口中，点击“还原”按钮以安装项目所需的 NuGet 包。

4.4 配置项目

在 NoteWidgetAddIn 项目中，找到 App.config 文件，确保其中的配置项正确无误。特别是 OneNote 的 API 配置部分。

4.5 编译项目

点击 Visual Studio 中的“生成”菜单，选择“生成解决方案”。如果一切顺利，项目将会成功编译。

4.6 部署插件

编译完成后，您可以在 NoteWidgetAddIn\bin\Debug 或 NoteWidgetAddIn\bin\Release 文件夹中找到生成的插件文件。将这些文件复制到 OneNote 的插件目录中，通常位于 C:\Users\<用户名>\AppData\Local\Microsoft\OneNote\<版本号>\AddIns。

4.7 启动 OneNote 并启用插件

启动 OneNote，点击“文件”菜单，选择“选项” -> “加载项”。在“COM 加载项”部分，点击“转到”按钮，勾选 NoteWidget 插件并点击“确定”。

4.8 使用插件

现在，您可以在 OneNote 中使用 NoteWidget 插件了。打开一个 OneNote 页面，点击插件栏中的 NoteWidget 图标，即可开始使用 Markdown 编辑和查看功能。

5. 常见问题及解决方法

• 插件无法加载: 确保 OneNote 和 .NET Framework 版本符合要求，并且插件文件路径正确。
• 语法高亮不显示: 检查 Markdig 和相关依赖项是否正确安装。
• Mermaid 图表无法渲染: 确保浏览器支持 Mermaid 库，并且网络连接正常。

通过以上步骤，您应该能够成功安装和配置 NoteWidget 插件，并在 OneNote 中享受 Markdown 编辑的便利。

NoteWidget Markdown add-in for Microsoft Office OneNote 项目地址: https://gitcode.com/gh_mirrors/no/NoteWidget