Grzesiek11/miuinotes2md
Watch
1
0
Fork
You've already forked miuinotes2md
 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions
Converts MIUI Notes (com.miui.notes) data to Markdown (CommonMark).
6 commits 1 branch 1 tag 52 KiB
  • Rust 97.6%
  • Python 2.4%
Find a file
Exact
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Grzesiek11 86fc875e45
 Add md2pandoc script
2026-09-23 11:47:10 +02:00
src Initial commit 2026-09-20 09:43:35 +02:00
.gitignore Initial commit 2026-09-20 09:43:35 +02:00
Cargo.lock Update project name in lock file 2026-09-20 11:02:40 +02:00
Cargo.toml Initial commit 2026-09-20 09:43:35 +02:00
LICENSE Initial commit 2026-09-20 09:43:35 +02:00
md2pandoc.py Add md2pandoc script 2026-09-23 11:47:10 +02:00
README.md Update README 2026-09-20 11:04:18 +02:00

README.md

miuinotes2md

Converts MIUI Notes (com.miui.notes) data to Markdown (CommonMark).

See md2quillpad to convert the output of this tool into a Quillpad backup.

Made for my sister :)

Usage

Get a copy of /data/user/<userid>/com.miui.notes.

This is not possible without root, and rooting usually requires wiping user data. To work around this, you can backup notes to Mi Cloud (or possibly locally with the builtin backup tool, not tested), then either root the phone or use a different rooted Xiaomi phone, and restore the backup. How to root a phone is beyond scope of this document, but a good place to start is the XDA Developers forum. Once you have a rooted phone with your notes, the easiest way to get a copy of the needed files is Neo Backup.

Put com.miui.notes/databases/note.db and com.miui.notes/files/attachment into the working directory as note.db and attachment.

Run the following command:

miuinotes2md

A notes directory will be generated. The output format is as defined by md2quillpad - in simple terms, the directory contains files ending with .md that contain note contents, and files ending with .json that contain note metadata. Additionally, it contains an attachments subdirectory, which contains the images used in the notes. Markdown files reference the images, with a path relative to them (for example, ![](attachments/attachment.png)).

Features

As I made this for my sister, this mostly just supports features that she used in her notes. Patches to add more welcome!

  • Regular notes
  • Mind maps: As nested lists
  • Todo lists
  • Folders
  • Creation date: As metadata
  • Modification date: As metadata
  • Images
  • Bold: As strong
  • Italic: As emphasis
  • Underline: Extension (__)
  • Large text: As level 2 heading
  • Lists
  • Checklists: Extension (- [ ], - [x])
  • Background color: Sis did use this, but converting it to styled spans wouldn't work in Quillpad (which was the target) anyways
  • Right alignment: Like with background color

Features not mentioned here are most likely missing.

Copyright

Copyright © 2026 Grzesiek11

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.