Skip to content

MarginNote/mn4-manual

Repository files navigation

MarginNote 4 用户手册

MarginNote 4 官方用户手册——从入门到精通,涵盖文档阅读、脑图笔记、闪卡复习、AI 功能等完整使用指南。

📖 在线预览

https://marginnote.github.io/mn4-manual/

🚀 快速开始

方式1:从 Wolai 添加新文章

  1. 在 Wolai 中导出文章为 HTML 格式
  2. 将导出的文件夹复制到 docs/对应类别/ 目录下
    • 例如:docs/脑图&卡片快速笔记/新文章名称/
  3. 运行自动化脚本(见下方"使用脚本")
  4. 提交并推送到 GitHub

方式2:添加新类别

  1. docs/ 下创建新的类别文件夹
    • 例如:docs/新类别名称/
  2. 将该类别的文章放入类别文件夹
  3. 运行自动化脚本
  4. 提交并推送到 GitHub

方式3:修改现有文章

  1. 用文本编辑器打开对应的 .html 文件
  2. 修改内容或替换图片
  3. 保存文件
  4. 提交并推送到 GitHub

🛠️ 使用脚本

打开终端

  1. 打开"终端"应用(应用程序 → 实用工具 → 终端)
  2. 输入以下命令进入项目目录:
cd /Users/randa/Desktop/mn-manual-docsify

脚本1:自动生成导航和页面(最常用)

用途: 添加新文章或新类别后,自动生成导航菜单和页面 index.html

使用方法:

# 一次性运行两个脚本
python3 generate_navigation.py && python3 create_index_files.py

效果:

  • 扫描 docs/ 目录结构
  • 生成 docs/navigation.js(导航菜单数据)
  • 为每个页面创建/更新 index.html(带导航框架的页面)

脚本2:修复图片说明重复

用途: Wolai 导出的 HTML 中,图片说明文字会重复两次,用这个脚本自动修复。

使用方法:

# 批量处理 docs 目录下所有文章
python3 fix_wolai_html.py docs/

# 修复单个文章
python3 fix_wolai_html.py "docs/脑图&卡片快速笔记/脑图卡片①:新建和编辑卡片/脑图卡片①:新建和编辑卡片.html"

效果: 会生成 文章_fixed.html,然后用它替换原文件即可。

脚本3:批量限制图片大小

用途: 自动给所有文章的 CSS 添加图片大小限制,避免图片过大。

使用方法:

# 批量处理 docs 目录下所有文章(默认700px)
python3 add_image_limit.py docs/

# 自定义图片最大宽度(比如500px)
python3 add_image_limit.py docs/ 500px

效果: 自动修改所有 css/wolai.css 文件,添加或更新图片大小限制。

脚本4:修复 Wolai 链接

用途: 将 Wolai 导出的 HTML 中的 Wolai 链接转换为本地内部链接。

当前功能: 修复同页面内的跳转链接

使用方法:

# 批量处理 docs 目录下所有文章
python3 fix_wolai_links.py docs/

# 处理单个文章
python3 fix_wolai_links.py "docs/脑图&卡片快速笔记/脑图卡片①:新建和编辑卡片/脑图卡片①:新建和编辑卡片.html"

效果:

  • https://www.wolai.com/页面ID#锚点 转换为 #锚点
  • 生成 文章_fixed_links.html,确认后替换原文件

注意: 跨页面链接的修复功能将在所有页面导出后添加(详见 TODO.md

自定义图片最大宽度(比如500px)

python3 add_image_limit.py docs/ 500px


**效果:** 自动修改所有 `css/wolai.css` 文件,添加图片大小限制。

## 👥 协作指南

### 替换错误图片

1. 网站和wolai 左右分屏,检查网站上的图片是否正确
2. 若发现网站上图片错配,原因是 wolai 的图片没有下载到 media 文件夹中。在 Wolai中下载正确的图片,保存到对应文章的 `media/` 文件夹,并给图片起一个合适的名字,
3. 在 media 文件夹中找到错误图片,记住它的名称,然后用文本编辑器打开HTML 文件,搜索错误图片的名称,修改`<img src="media/xxx.png">` 中的xxx为正确的图片名(对应你刚才下载的那张图片)
4. 在 GitHub Desktop 提交并推送

### 完整工作流程

```bash
# 1. 进入项目目录
cd /Users/randa/Desktop/mn-manual-docsify

# 2. 将 Wolai 导出的文章复制到 docs/对应类别/ 下

# 3. 修复新添加的文章(图片说明重复问题)
python3 fix_wolai_html.py "docs/类别名称/新文章/新文章.html"

# 4. 添加图片大小限制
python3 add_image_limit.py docs/

# 5. 自动生成导航和页面
python3 generate_navigation.py && python3 create_index_files.py

# 6. 打开 GitHub Desktop 提交更改
# - 写提交信息:"添加新文章:xxx"
# - 点击 "Commit to main"
# - 点击 "Push origin"

本地预览

cd docs/脑图卡片①:新建和编辑卡片
python3 -m http.server 8081

然后访问:http://localhost:8081/index.html

项目结构

mn-manual-docsify/
├── index.html                  # 主入口(首页)
├── README.md                   # 说明文档
├── template_index.html         # 页面模板(自动生成用)
├── generate_navigation.py      # 自动生成导航菜单
├── create_index_files.py       # 自动创建页面 index.html
├── fix_wolai_html.py           # 修复图片说明重复
├── add_image_limit.py          # 添加图片大小限制
└── docs/                       # 所有文章
    ├── navigation.js           # 导航菜单数据(自动生成)
    └── 脑图&卡片快速笔记/      # 类别文件夹
        ├── 脑图卡片①:新建和编辑卡片/
        │   ├── index.html              # 带导航的页面(自动生成)
        │   ├── 脑图卡片①:新建和编辑卡片.html  # Wolai 导出的内容
        │   ├── media/                  # 图片文件夹
        │   └── css/                    # 样式文件
        └── 脑图卡片②:移动、合并、重组/
            └── ...

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors