Skip to content

Chore (docs): Add getting started warning for python 3.12 with node LTS #2536

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
EltonGohJH merged 2 commits into from
Apr 28, 2024
Merged

Chore (docs): Add getting started warning for python 3.12 with node LTS #2536

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f823fe6
Add quick getting started warning to the docs
kaixin-hc Apr 28, 2024
23ec3ee
Correct missing typo + add note to dev guide
kaixin-hc Apr 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/devGuide/development/settingUp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`

<box type="warning" seamless>

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.
</box>
<box type="tip" seamless>

We recommend the **WebStorm IDE** or **VS Code** for working with MarkBind code.
Expand Down
5 changes: 5 additions & 0 deletions docs/userGuide/gettingStarted.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@
%%{{ icon_ticked }}%% [Node.js](https://nodejs.org) {{ node_version }} or higher installed
</div>

<box type="warning" seamless>

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.
</box>

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
Expand Down