Skip to content

Commit 21226e1

Browse files
committed
Trying to fix markdown in details
1 parent 3aced86 commit 21226e1

2 files changed

Lines changed: 11 additions & 7 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## Documentation
88

9-
Please read [the documentation page](./docs/README.md) to know all the user-facing details around this module.
9+
Please read [the documentation page](https://pyscript.github.io/polyscript/) to know all the user-facing details around this module.
1010

1111
## Development
1212

docs/README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Polyscript Documentation
1+
# Polyscript
2+
3+
<small><strong><a href="https://github.com/pyscript/pyscript">PyScript</a> single core to rule them all</strong></small>
4+
5+
- - -
26

37
* [Terminology](#terminology) - what we mean by "_term_" in this document
48
* [Bootstrapping core](#bootstrapping-core) - how to enable Polyscript in your page
@@ -14,7 +18,7 @@ This section goal is to avoid confusion around topics discussed in this document
1418

1519
<details>
1620
<summary><strong>Interpreter</strong></summary>
17-
<div>
21+
<div markdown=1>
1822

1923
Also commonly referred as *runtime* or *engine*, we consider an **interpreter** any "_piece of software_" able to parse, understand, and ultimately execute, a *Programming Language* through this project.
2024

@@ -56,7 +60,7 @@ Custom values for the `type` attribute can also be created which alias (and pote
5660

5761
<details>
5862
<summary><strong>Target</strong></summary>
59-
<div>
63+
<div markdown=1>
6064

6165
When it comes to *strings* or *attributes*, we consider the **target** any valid element's *id* on the page or, in most cases, any valid *CSS* selector.
6266

@@ -105,7 +109,7 @@ When it comes to the `property` or `field` attached to a `<script>` element thou
105109

106110
<details>
107111
<summary><strong>Env</strong></summary>
108-
<div>
112+
<div markdown=1>
109113

110114
ℹ️ - This is an **advanced feature** that is worth describing but usually it is not needed for most common use cases.
111115

@@ -202,7 +206,7 @@ These are all special, *script* related features, offered by *polyscript* out of
202206

203207
<details>
204208
<summary><strong>document.currentScript</strong></summary>
205-
<div>
209+
<div markdown=1>
206210

207211
No matter the interpreter of choice, if there is any way to reach the `document` from such interpreter, its `currentScript` will point at the exact/very-same script that is currently executing the code, even if its `async` attribute is used, mimicking what the standard [document.currentScript](https://developer.mozilla.org/en-US/docs/Web/API/Document/currentScript) offers already, and in an unobtrusive way for the rest of the page, as this property only exists for *synchronous* and blocking scripts that are running, hence never interfering with this *core* logic or vice-versa.
208212

@@ -227,7 +231,7 @@ Please read the [Terminology](#terminology) **target** dedicated details to know
227231

228232
<details>
229233
<summary><strong>XWorker</strong></summary>
230-
<div>
234+
<div markdown=1>
231235

232236
With or without access to the `document`, every (*non experimental*) interpreter will have defined, either at the global level or after an import (i.e.`from polyscript import XWorker` in *Python* case), a reference to the `XWorker` "_class_" (it's just a *function*!), which goal is to enable off-loading heavy operations on a worker, without blocking the main / UI thread (the current page) and allowing such worker to even reach the `document` or anything else available on the very same main / UI thread.
233237

0 commit comments

Comments
 (0)