diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml deleted file mode 100644 index 17cca6bcf..000000000 --- a/.github/FUNDING.yml +++ /dev/null @@ -1,5 +0,0 @@ -# These are supported funding model platforms - -patreon: ranluo -open_collective: marktext -custom: https://paypal.me/ranluo?locale.x=zh_XC diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 9b5b6cdf9..000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - -### Description - - - -### Steps to reproduce - -1. [First step] -2. [Second step] -3. [and so on...] - -**Expected behavior:** - - - -**Actual behavior:** - - - -**Link to an example: [optional]** - - - -### Versions - -- MarkText: -- Operating system: diff --git a/README.md b/README.md index 8b4fb12cf..0230dad09 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ +> [!NOTE] +> This repository is now archived. Please check out [@Tkaixiang's fork](https://github.com/Tkaixiang/marktext) for more recent work on Marktext. + # MarkText Original README.md translations: @@ -19,6 +22,11 @@ This is a fork of [the official MarkText repository](https://github.com/marktext My intent is to keep Marktext alive while there is a lull in engagement from the official repo's owners. If the maintainers choose to bring that repository back to life, I'll sunset this fork in favor of theirs. +**I have very limited time, all I can really do is make sure the app can still run. +If you would like to see this project grow, please do what you can to help! +I will prioritize PR reviews. +Thank you.** + ## Installing ### Linux diff --git a/docs/dev/BUILD.md b/docs/dev/BUILD.md index 8c4d22a90..38733e823 100644 --- a/docs/dev/BUILD.md +++ b/docs/dev/BUILD.md @@ -1,11 +1,41 @@ # Build Instructions +**Please see [this issue](https://github.com/jacobwhall/marktext/issues/2) for updates on our efforts to modernize this process!** + Clone the repository: ``` git clone https://github.com/marktext/marktext.git ``` +## Container Setup + +The Marktext build process currently relies on an old version of node. +The easiest way to build Marktext for Linux right now is from inside a container. +Here are the steps for doing so: +```sh +# cd to marktext repository + +# run container (you can use docker instead of podman if you like) +podman run -it -v ./:/mnt:Z node:18.19-bookworm /bin/bash +# you should now be interacting with the container + +# install dependency xkbfile +apt update +apt-get install libx11-dev libxkbfile-dev libsecret-1-dev libfontconfig-dev rpm + +cd /mnt +yarn install +yarn run build + +exit +# container should now be terminated + +# build artifacts can be found in build directory +``` + +Below are the complete build instructions, which may help you troubleshoot the above or attempt to build for other platforms. + ### Prerequisites Before you can get started developing, you need set up your build environment: @@ -21,8 +51,9 @@ Before you can get started developing, you need set up your build environment: - libxkbfile (with headers) - libsecret (with headers) - libfontconfig (with headers) +- rpm (if building on Debian) -On Debian-based Linux: `sudo apt-get install libx11-dev libxkbfile-dev libsecret-1-dev libfontconfig-dev` +On Debian-based Linux: `sudo apt-get install libx11-dev libxkbfile-dev libsecret-1-dev libfontconfig-dev rpm` On Red Hat-based Linux: `sudo dnf install libX11-devel libxkbfile-devel libsecret-devel fontconfig-devel` diff --git a/package.json b/package.json index 5253857f7..c0f3f7260 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "marktext", - "version": "0.17.4", + "version": "0.17.5", "homepage": "https://github.com/jacobwhall/marktext/", "description": "Next generation markdown editor", "license": "MIT", @@ -66,7 +66,7 @@ "joplin-turndown-plugin-gfm": "^1.0.12", "katex": "^0.15.3", "keytar": "^7.9.0", - "mermaid": "^9.2.2", + "mermaid": "^10.6.1", "minizlib": "^2.1.2", "native-keymap": "^3.3.0", "plist": "^3.0.4", diff --git a/src/muya/lib/renderers/index.js b/src/muya/lib/renderers/index.js index 6d4015e9b..89ba15750 100644 --- a/src/muya/lib/renderers/index.js +++ b/src/muya/lib/renderers/index.js @@ -20,7 +20,7 @@ const loadRenderer = async (name) => { rendererCache.set(name, m.default) break case 'mermaid': - m = await import('mermaid/dist/mermaid.min.js') + m = await import('mermaid/dist/mermaid.core.mjs') rendererCache.set(name, m.default) break case 'vega-lite':