From f823fe6cc71c84dd9daf79274e2622ecd55c1d9f Mon Sep 17 00:00:00 2001 From: Hannah Date: Sun, 28 Apr 2024 11:25:05 +0700 Subject: [PATCH 1/2] Add quick getting started warning to the docs --- docs/userGuide/gettingStarted.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/userGuide/gettingStarted.md b/docs/userGuide/gettingStarted.md index 6c7b0fcdcf..49fed5e2b4 100644 --- a/docs/userGuide/gettingStarted.md +++ b/docs/userGuide/gettingStarted.md @@ -19,6 +19,11 @@ %%{{ icon_ticked }}%% [Node.js](https://nodejs.org) {{ node_version }} or higher installed + + +With Node LTS (v20), the python used has updated to 3.12, and [you may get an error](https://github.com/MarkBind/markbind/issues/2496). You can solve this issue by installing setuptools or deprecating the versions used + + There are a few ways to install MarkBind, select one that is most suitable for your use case. If you are unsure, we recommend using the first method. ## Method 1: Install MarkBind globally with npm From 23ec3ee3fc0c84a6c05e5f092dd7d7fa8de538ab Mon Sep 17 00:00:00 2001 From: Hannah Date: Sun, 28 Apr 2024 15:24:55 +0700 Subject: [PATCH 2/2] Correct missing typo + add note to dev guide --- docs/devGuide/development/settingUp.md | 4 ++++ docs/userGuide/gettingStarted.md | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/devGuide/development/settingUp.md b/docs/devGuide/development/settingUp.md index 051dc90a14..b9c3fa6dc7 100644 --- a/docs/devGuide/development/settingUp.md +++ b/docs/devGuide/development/settingUp.md @@ -32,6 +32,10 @@ This page explains how to set up your development environment to start contribut * `dot -V` (for Graphviz - optional on Windows) * `python3 -V` + + +With Node LTS (v20), the python used has updated to 3.12, and [you may get an error](https://github.com/MarkBind/markbind/issues/2496). You can solve this issue by installing setuptools or deprecating the versions used. + We recommend the **WebStorm IDE** or **VS Code** for working with MarkBind code. diff --git a/docs/userGuide/gettingStarted.md b/docs/userGuide/gettingStarted.md index 49fed5e2b4..696521e6f4 100644 --- a/docs/userGuide/gettingStarted.md +++ b/docs/userGuide/gettingStarted.md @@ -21,7 +21,7 @@ -With Node LTS (v20), the python used has updated to 3.12, and [you may get an error](https://github.com/MarkBind/markbind/issues/2496). You can solve this issue by installing setuptools or deprecating the versions used +With Node LTS (v20), the python used has updated to 3.12, and [you may get an error](https://github.com/MarkBind/markbind/issues/2496). You can solve this issue by installing setuptools or deprecating the versions used. There are a few ways to install MarkBind, select one that is most suitable for your use case. If you are unsure, we recommend using the first method.