{"id":15895507,"url":"https://github.com/maqi1520/mdx-notes","last_synced_at":"2025-05-14T19:08:07.000Z","repository":{"id":38407324,"uuid":"475238966","full_name":"maqi1520/mdx-notes","owner":"maqi1520","description":"⛷ Cross-platform note-taking software, public layout editor, using MDX ⛷ 跨平台笔记软件，公众号排版编辑器，使用MDX来排版","archived":false,"fork":false,"pushed_at":"2025-03-25T12:37:39.000Z","size":32388,"stargazers_count":1336,"open_issues_count":19,"forks_count":162,"subscribers_count":10,"default_branch":"tauri-app","last_synced_at":"2025-04-13T17:46:40.829Z","etag":null,"topics":["markdown","markdown-editor","mdx","nextjs","note-taking","notes"],"latest_commit_sha":null,"homepage":"https://mdxnotes.com/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/maqi1520.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-03-29T01:35:42.000Z","updated_at":"2025-04-13T17:04:10.000Z","dependencies_parsed_at":"2023-02-10T20:01:34.331Z","dependency_job_id":"94b0e68f-0644-4e14-abdc-94ae1a66e487","html_url":"https://github.com/maqi1520/mdx-notes","commit_stats":{"total_commits":225,"total_committers":2,"mean_commits":112.5,"dds":"0.013333333333333308","last_synced_commit":"7b741813f38fccb89d92e51f26d396999661bb17"},"previous_names":["maqi1520/mdx-notes"],"tags_count":78,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maqi1520%2Fmdx-notes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maqi1520%2Fmdx-notes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maqi1520%2Fmdx-notes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maqi1520%2Fmdx-notes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maqi1520","download_url":"https://codeload.github.com/maqi1520/mdx-notes/tar.gz/refs/heads/tauri-app","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254209859,"owners_count":22032897,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["markdown","markdown-editor","mdx","nextjs","note-taking","notes"],"created_at":"2024-10-06T09:01:38.867Z","updated_at":"2025-05-14T19:08:04.098Z","avatar_url":"https://github.com/maqi1520.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003ch4 align=\"right\"\u003e\u003cstrong\u003eEnglish\u003c/strong\u003e | \u003ca href=\"https://github.com/maqi1520/mdx-notes/blob/tauri-app/README_CN.md\"\u003e简体中文\u003c/a\u003e\u003c/h4\u003e\n\n\u003cdiv align=\"center\"\u003e\n\u003ca href=\"https://mdxnotes.com/\"\u003e\n\u003cimg width=\"500\" src=\"./public/social-card.jpg\"/\u003e\n\u003c/a\u003e\n\u003c/div\u003e\n\u003cdiv align=\"center\"\u003e \u003ca href=\"https://github.com/maqi1520/mdx-notes/actions\"\u003e\n    \u003cimg src=\"https://github.com/maqi1520/mdx-notes/actions/workflows/release.yml/badge.svg\" alt=\"\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/maqi1520/mdx-notes/releases\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/downloads/maqi1520/mdx-notes/total.svg\" alt=\"\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/maqi1520/mdx-notes/releases/latest\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/release/maqi1520/mdx-notes.svg\" alt=\"\"\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\u003ch1 align=\"center\"\u003eMDX Notes\u003c/h1\u003e\n\n\u003e A versatile WeChat typesetting editor, also serving as a cross-platform Markdown note-taking software.\n\n## Inspiration\n\nMarkdown, 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/).\n\n## Features\n\n### Web Version\n\n- Seamlessly copy to WeChat Official Accounts with just a click\n- Customize styled components and styles, generate QR codes and code diff highlights\n- Generate article indexes effortlessly\n- Create WeChat footnotes with ease\n- Automatically convert WeChat external links into `span` elements\n- Ensure code formatting precision\n- Facilitate article sharing with built-in functionality\n- Download markdown files effortlessly\n- Export to PDF seamlessly\n\n### Desktop Version\n\nIn addition to the web version's features, the desktop version includes:\n\n- Real-time local file saving\n- Efficient management of local file directories\n- Hassle-free HTML export functionality\n\n## Template Examples\n\n\u003ctable\u003e\n\u003ctr\u003e\n    \u003ctd\u003e\u003cimg src=\"https://user-images.githubusercontent.com/9312044/262275142-ce7f3e70-cbad-449e-999e-4cba33f75000.png\"/\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003cimg src=\"https://user-images.githubusercontent.com/9312044/262275149-3310abc1-5a6d-45cb-aa9a-3359381ec429.png\"/\u003e\u003c/td\u003e\n\u003c/tr\u003e \n\u003ctr\u003e\n    \u003ctd\u003e\u003ca href=\"https://mdxnotes.com/post?id=64b51328337a9f4db79fe677\" \u003eSubtle Green Card\u003c/a\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ca href=\"https://mdxnotes.com/post?id=64c0fca121821b2af589cf6e\"\u003eEarly Summer Style\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e \n\u003ctr\u003e\n  \u003ctd\u003e\u003cimg src=\"https://user-images.githubusercontent.com/9312044/262275160-41c30692-b554-4da6-bcc7-3fb00169ed5d.png\"/\u003e\u003c/td\u003e\n  \u003ctd\u003e\u003cimg src=\"https://user-images.githubusercontent.com/9312044/262275117-fdf35fe4-0b70-45ad-995d-b6622586c6d8.png\"/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n  \u003ctd\u003e\u003ca href=\"https://mdxnotes.com/post?id=624688ccb6fe2900015728ac\"\u003eResume Template\u003c/a\u003e\u003c/td\u003e\n  \u003ctd\u003e\u003ca href=\"https://mdxnotes.com/post?id=625550658cc5730001809f0c\"\u003eExquisite Code Diff Highlights\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n    \u003ctd\u003e\u003cimg src=\"https://user-images.githubusercontent.com/9312044/262275165-766ff817-7c09-4288-b8dd-55d7424c2fd6.png\"/\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003cimg src=\"https://user-images.githubusercontent.com/9312044/262275168-6dd4b05c-a604-4ab1-abe3-b2d2dc759d8e.png\"/\u003e\u003c/td\u003e\n\u003c/tr\u003e \n\u003ctr\u003e\n    \u003ctd\u003e\u003ca href=\"https://mdxnotes.com/post?id=6492ae0109e298c79055dfab\"\u003eGenerate Captivating QR Codes\u003c/a\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ca href=\"https://mdxnotes.com/post?id=6492aa37f5cf3a54f14493a8\"\u003eTravel Itinerary\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e \n\u003c/table\u003e\n\n## Development\n\nTo access the web version, switch to the `main` branch and follow these commands:\n\n```bash\nyarn\nyarn dev\n```\n\nFor the desktop version, switch to the `tauri-app` branch and execute the following commands:\n\n```bash\nyarn\nyarn tauri dev\n```\n\n## FAQ\n\n### 1. After installing on macOS, it shows \"The file is damaged\" or there is no response when opening it\n\nBecause MDX Notes is not signed, it is blocked by macOS security checks.\n\nIf you encounter the \"The file is damaged\" error after installation, follow these steps:\n\nTrust the developer, and it will prompt you to enter your password:\n\n```bash\nsudo spctl --master-disable\n```\n\nThen allow MDX Notes:\n\n```bash\nxattr -cr /Applications/MDX\\ Notes.app\n```\n\nAfter that, you should be able to open it normally.\n\nIf you see the following message:\n\n```sh\noption -r not recognized\n\nusage: xattr [-slz] file [file ...]\n       xattr -p [-slz] attr_name file [file ...]\n       xattr -w [-sz] attr_name attr_value file [file ...]\n       xattr -d [-s] attr_name file [file ...]\n       xattr -c [-s] file [file ...]\n\nThe first form lists the names of all xattrs on the given file(s).\nThe second form (-p) prints the value of the xattr attr_name.\nThe third form (-w) sets the value of the xattr attr_name to attr_value.\nThe fourth form (-d) deletes the xattr attr_name.\nThe fifth form (-c) deletes (clears) all xattrs.\n\noptions:\n  -h: print this help\n  -s: act on symbolic links themselves rather than their targets\n  -l: print long format (attr_name: attr_value)\n  -z: compress or decompress (if compressed) attribute value in zip format\n```\n\nExecute the command:\n\n```bash\nxattr -c /Applications/MDX\\ Notes.app/*\n```\n\nIf the above command still doesn't work, you can try the following command:\n\n```bash\nsudo xattr -d com.apple.quarantine /Applications/MDX\\ Notes.app/\n```\n\n## Deployment\n\nDeployed using the [Vercel Platform](https://vercel.com/import?utm_medium=default-template\u0026filter=next.js\u0026utm_source=create-next-app\u0026utm_campaign=create-next-app-readme) from the creators of Next.js.\n\n## References\n\n- [mdxjs playground](https://mdxjs.com/playground/)\n- [play.tailwindcss.com](https://play.tailwindcss.com/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaqi1520%2Fmdx-notes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaqi1520%2Fmdx-notes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaqi1520%2Fmdx-notes/lists"}