Skip to content

MarginNote/mn4-manual

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

101 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MarginNote 4 用户手册

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

在线访问: https://marginnote.github.io/mn4-manual/


添加新文章

完整流程

  1. 在 Wolai 中导出文章为 HTML 格式
  2. 将导出的文件夹放入 docs/对应分类/ 目录下
    docs/
    └── 文档快速笔记/
        └── 新文章名称/          ← 放在这里
            ├── 新文章名称.html
            ├── media/
            └── css/
    
  3. 在终端运行一键脚本:
    python3 setup_new_pages.py
  4. 打开 GitHub Desktop → 提交 → 推送

脚本自动完成的事情

脚本按顺序执行以下 6 个步骤,全程无需人工干预:

步骤 内容
1 修复 Wolai 导出问题(图片说明重复、alt 重复、链接转换等)
2 给每个页面的 CSS 添加图片最大宽度限制(700px)
3 修复多列布局的横向滚动问题
4 扫描 docs/ 目录,生成导航数据(docs/navigation.js
5 template_index.html 为每个页面生成 index.html
6 提取每个页面的缩略图和描述文字,写回 navigation.js

添加新分类

  1. docs/ 下新建分类文件夹(文件夹名即为分类名)
  2. 将文章放入该分类文件夹
  3. 运行 python3 setup_new_pages.py
  4. 提交并推送

修改现有文章

  1. 用文本编辑器打开对应的 .html 文件直接编辑
  2. 保存后提交并推送

修复错误图片

当发现网站上的图片与 Wolai 中不一致时:

  1. 在 Wolai 中下载正确图片,保存到对应文章的 media/ 文件夹
  2. 用文本编辑器打开该文章的 .html 文件,搜索错误图片的文件名
  3. <img src="media/错误图片名.png"> 改为正确的文件名
  4. 保存、提交、推送

特殊导航条目

docs/navigation.js 中排在最前面的分类(如「界面导览」)不是通过扫描 docs/ 目录自动生成的,而是由 custom_navigation.json 手动维护。

如需修改这些特殊条目,直接编辑 custom_navigation.json 即可,运行脚本后会自动合并进 navigation.js


本地预览

cd /Users/randa/Desktop/mn-manual-docsify
python3 -m http.server 8080

访问 http://localhost:8080/docs/index.html


项目结构

mn-manual-docsify/
├── docs/
│   ├── index.html              # 手册首页
│   ├── navigation.js           # 导航数据(自动生成,勿手动编辑)
│   └── <分类名>/
│       └── <文章名>/
│           ├── index.html              # 带导航框架的页面(自动生成)
│           ├── <文章名>.html           # Wolai 导出的内容
│           ├── media/                  # 图片
│           └── css/                    # 样式
├── template_index.html         # 页面框架模板
├── custom_navigation.json      # 特殊导航条目(手动维护)
└── setup_new_pages.py          # 一键处理脚本(唯一需要运行的脚本)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors