Skip to content

Fix mistakes in js_modules related docs. Mention this is Pyodide only. #56

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
merged 1 commit into from
Dec 15, 2023
Merged

Fix mistakes in js_modules related docs. Mention this is Pyodide only. #56

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 19 additions & 5 deletions docs/user-guide/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,11 @@ plugins = ["custom_plugin", "!error"]

It's easy to import and use JavaScript modules in your Python code.

!!! warning

This feature currently only works with Pyodide. MicroPython support will
come in a future release.

To do so, requires telling PyScript about the JavaScript modules you want to
use. This is the purpose of the `js_modules` related configuration fields.

Expand Down Expand Up @@ -347,9 +352,11 @@ module for creating interactive maps you'd add the following lines:

```JSON title="JavaScript main thread modules defined in JSON"
{
"js_modules.main": {
"https://cdn.jsdelivr.net/npm/leaflet@1.9.4/dist/leaflet-src.esm.js": "leaflet",
"https://cdn.jsdelivr.net/npm/leaflet@1.9.4/dist/leaflet.css": "leaflet"
"js_modules": {
"main": {
"https://cdn.jsdelivr.net/npm/leaflet@1.9.4/dist/leaflet-src.esm.js": "leaflet",
"https://cdn.jsdelivr.net/npm/leaflet@1.9.4/dist/leaflet.css": "leaflet"
}
}
}
```
Expand Down Expand Up @@ -385,10 +392,17 @@ Some JavaScript modules (such as
access to the DOM and, for efficiency reasons, can be included in the worker
context:

```TOML title="A JavaScript worker module defined in TOML"
[js_modules.worker]
"https://cdn.jsdelivr.net/npm/html-escaper" = "html_escaper"
```

```JSON title="A JavaScript worker module defined in JSON"
{
"js_modules.worker": {
"https://cdn.jsdelivr.net/npm/html-escaper": "html_escaper"
"js_modules": {
"worker": {
"https://cdn.jsdelivr.net/npm/html-escaper": "html_escaper"
}
}
}
```
Expand Down