Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maqi1520/mdx-notes
⛷ Cross-platform note-taking software, public layout editor, using MDX ⛷ 跨平台笔记软件，公众号排版编辑器，使用MDX来排版
https://github.com/maqi1520/mdx-notes
markdown markdown-editor mdx nextjs note-taking notes
Last synced: 3 days ago
JSON representation
⛷ Cross-platform note-taking software, public layout editor, using MDX ⛷ 跨平台笔记软件，公众号排版编辑器，使用MDX来排版
- Host: GitHub
- URL: https://github.com/maqi1520/mdx-notes
- Owner: maqi1520
- License: gpl-3.0
- Created: 2022-03-29T01:35:42.000Z (over 2 years ago)
- Default Branch: tauri-app
- Last Pushed: 2024-12-11T01:00:43.000Z (12 days ago)
- Last Synced: 2024-12-13T02:03:25.831Z (10 days ago)
- Topics: markdown, markdown-editor, mdx, nextjs, note-taking, notes
- Language: TypeScript
- Homepage: https://mdxnotes.com/
- Size: 31.4 MB
- Stars: 1,101
- Watchers: 10
- Forks: 142
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
English | 简体中文
MDX Notes
> A versatile WeChat typesetting editor, also serving as a cross-platform Markdown note-taking software.
## Inspiration
Markdown, beloved by countless programmers as a writing format, falls short in meeting the typesetting demands of WeChat. Fortunately, MDX comes to the rescue, mending Markdown's inadequacies. As my own blog utilizes MDX for writing, I pondered upon the possibility of achieving a unified solution for writing and typesetting when I stumbled upon the [mdxjs playground](https://mdxjs.com/playground/).
## Features
### Web Version
- Seamlessly copy to WeChat Official Accounts with just a click
- Customize styled components and styles, generate QR codes and code diff highlights
- Generate article indexes effortlessly
- Create WeChat footnotes with ease
- Automatically convert WeChat external links into `span` elements
- Ensure code formatting precision
- Facilitate article sharing with built-in functionality
- Download markdown files effortlessly
- Export to PDF seamlessly
### Desktop Version
In addition to the web version's features, the desktop version includes:
- Real-time local file saving
- Efficient management of local file directories
- Hassle-free HTML export functionality
## Template Examples
Subtle Green Card
Early Summer Style
Resume Template
Exquisite Code Diff Highlights
Generate Captivating QR Codes
Travel Itinerary
## Development
To access the web version, switch to the `main` branch and follow these commands:
```bash
yarn
yarn dev
```
For the desktop version, switch to the `tauri-app` branch and execute the following commands:
```bash
yarn
yarn tauri dev
```
## FAQ
### 1. After installing on macOS, it shows "The file is damaged" or there is no response when opening it
Because MDX Notes is not signed, it is blocked by macOS security checks.
If you encounter the "The file is damaged" error after installation, follow these steps:
Trust the developer, and it will prompt you to enter your password:
```bash
sudo spctl --master-disable
```
Then allow MDX Notes:
```bash
xattr -cr /Applications/MDX\ Notes.app
```
After that, you should be able to open it normally.
If you see the following message:
```sh
option -r not recognized
usage: xattr [-slz] file [file ...]
xattr -p [-slz] attr_name file [file ...]
xattr -w [-sz] attr_name attr_value file [file ...]
xattr -d [-s] attr_name file [file ...]
xattr -c [-s] file [file ...]
The first form lists the names of all xattrs on the given file(s).
The second form (-p) prints the value of the xattr attr_name.
The third form (-w) sets the value of the xattr attr_name to attr_value.
The fourth form (-d) deletes the xattr attr_name.
The fifth form (-c) deletes (clears) all xattrs.
options:
-h: print this help
-s: act on symbolic links themselves rather than their targets
-l: print long format (attr_name: attr_value)
-z: compress or decompress (if compressed) attribute value in zip format
```
Execute the command:
```bash
xattr -c /Applications/MDX\ Notes.app/*
```
If the above command still doesn't work, you can try the following command:
```bash
sudo xattr -d com.apple.quarantine /Applications/MDX\ Notes.app/
```
## Deployment
Deployed using the [Vercel Platform](https://vercel.com/import?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
## References
- [mdxjs playground](https://mdxjs.com/playground/)
- [play.tailwindcss.com](https://play.tailwindcss.com/)