Skip to content

Commit 65fc5c0

Browse files
committed
docs: adjust to different md flavor
1 parent 823ec7c commit 65fc5c0

File tree

6 files changed

+25
-22
lines changed

6 files changed

+25
-22
lines changed

docs/SA-Wiki/Cloud-Requests.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ New in v2.0: Cloud Requests now use threading.Event which massively lowers CPU u
66

77
**Add Cloud Requests to your Scratch project:**
88

9-
Download this project file to your computer (click the link to download it): https://github.com/TimMcCool/scratchattach/raw/main/assets/CloudRequests_Template.sb3
9+
Download this project file to your computer (click the link to download it): <https://github.com/TimMcCool/scratchattach/raw/main/assets/CloudRequests_Template.sb3>
1010

1111
Then, go to the Scratch website, create a new project and upload the project file from above.
1212

1313
**How to use with Scratch:**
1414

15-
Copy this code to your Python editor. [How to get your session id](https://github.com/TimMcCool/scratchattach/wiki/Get-your-session-id)
15+
Copy this code to your Python editor. [How to get your session id](../Get-your-session-id)
1616

1717
```py
1818
import scratchattach as sa
@@ -38,12 +38,12 @@ Then, run the code.
3838

3939
Now go to the Scratch project. In the `Cloud Requests` sprite, you will find this block:
4040

41-
![image](https://github.com/TimMcCool/scratchattach/blob/main/wiki/images/cr_tut_block.png)
41+
![image](https://raw.githubusercontent.com/TimMcCool/scratchattach/refs/heads/main/wiki/images/cr_tut_block.png)
4242

4343
When active, it sends a "ping" request to the Python client. This will call the `ping()` function. The data returned by the function will be sent back to the project.
4444
Try it out by clicking the block!
4545

46-
![image](https://github.com/TimMcCool/scratchattach/blob/main/wiki/images/cr_tut_restult.png)
46+
![image](https://raw.githubusercontent.com/TimMcCool/scratchattach/refs/heads/main/wiki/images/cr_tut_restult.png)
4747

4848
**How to use with TurboWarp:**
4949

@@ -62,7 +62,7 @@ client = cloud.requests()
6262

6363
Scratch code:
6464

65-
![image](https://github.com/TimMcCool/scratchattach/blob/main/wiki/images/cr_tut_example1.png)
65+
![image](https://raw.githubusercontent.com/TimMcCool/scratchattach/refs/heads/main/wiki/images/cr_tut_example1.png)
6666

6767
```python
6868
@client.request

docs/SA-Wiki/Cloud-Storage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Cloud Storage Framework that makes it easy to store project data by sending it o
44

55
**Add a Cloud Storage to your Scratch project:**
66

7-
Download this project file to your computer (click the link to download it): https://github.com/TimMcCool/scratchattach/raw/main/assets/CloudStorage_Template.sb3
7+
Download this project file to your computer (click the link to download it): <https://github.com/TimMcCool/scratchattach/raw/main/assets/CloudStorage_Template.sb3>
88

99
Then, go to the Scratch website, create a new project and upload the project file from above.
1010

docs/SA-Wiki/Get-your-session-id.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@
88
3. Go to the "Application" tab (in Firefox & DuckDuckGo the "Storage" tab), then go to "Cookies" > "https://scratch.mit.edu"
99
4. Then find a cookie named `scratchsessionsid`. The value of this cookie is your Scratch session id
1010

11-
![](https://github.com/TimMcCool/scratchattach/blob/main/wiki/images/cookies_tut_1.png)
11+
![](https://raw.githubusercontent.com/TimMcCool/scratchattach/refs/heads/main/wiki/images/cookies_tut_1.png)
1212

1313
For Firefox/DuckDuckGo:
14-
![](https://github.com/TimMcCool/scratchattach/blob/main/wiki/images/cookies_tut_3.png)
14+
![](https://raw.githubusercontent.com/TimMcCool/scratchattach/refs/heads/main/wiki/images/cookies_tut_3.png)
1515

1616
### For Safari:
1717
1. [Enable developer features](https://developer.apple.com/documentation/safari-developer-tools/enabling-developer-features)
@@ -31,4 +31,4 @@ For Firefox/DuckDuckGo:
3131
2. Click the 🔒 icon in the URL bar, then click "Cookies"
3232
3. Then find a cookie called `scratchsessionsid` (in the "scratch.mit.edu" » "Cookies" folder). The content of this cookie is your Scratch session id
3333

34-
![](https://github.com/TimMcCool/scratchattach/blob/main/wiki/images/cookies_tut_2.png)
34+
![](https://raw.githubusercontent.com/TimMcCool/scratchattach/refs/heads/main/wiki/images/cookies_tut_2.png)

docs/SA-Wiki/Hosting.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,25 +59,25 @@ Offers cheap VPS (Virtual private servers) for hosting any kind of code. The low
5959

6060
# More
6161

62-
https://dash.huguitisnodes.host/register
62+
<https://dash.huguitisnodes.host/register>
6363
Video timestamp: [0:04](https://youtu.be/lPYJu3crgGg?t=4)
6464
> best for running 1-2 scripts, no renewal required!
6565
6666

67-
https://bot-hosting.net/
67+
<https://bot-hosting.net/>
6868
Video timestamp: [3:47](https://youtu.be/lPYJu3crgGg?t=227)
6969
> Second best for running one or two scripts for a long time - requires you to earn credits. You can earn enough credits in one day to run your server for a week.
7070
71-
https://panel.sillydev.co.uk/
71+
<https://panel.sillydev.co.uk/>
7272
Video timestamp: [7:06](https://youtu.be/lPYJu3crgGg?t=426)
7373
> Best if you need lots of scripts running 24/7
7474
75-
https://www.hidencloud.com/
75+
<https://www.hidencloud.com/>
7676
Video timestamp: [9:37](https://youtu.be/lPYJu3crgGg?t=577)
7777
> Lets you run one script and requires renewal once a week.
7878
79-
https://botcore.org/
79+
<https://botcore.org/>
8080
Video timestamp: [14:29](https://youtu.be/lPYJu3crgGg?t=869)
8181
> Similar to sillydev, but required frequent renewals and server resources are expensive
8282
83-
https://skycastle.us/
83+
<https://skycastle.us/>

docs/SA-Wiki/Project-parsing-editing.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
Scratchattach provides a submodule `editor` for project parsing/editing. It is useful for extracting data from projects, or performing repetitive operations.
22

3-
> [!NOTE]
4-
> Scratchattach.editor is work-in-progress. If there is a feature missing or a strange bug, [please add an issue!](https://github.com/TimMcCool/scratchattach/issues)
3+
!!! Note
4+
5+
Scratchattach.editor is work-in-progress. If there is a feature missing or a strange bug, [please add an issue!](https://github.com/TimMcCool/scratchattach/issues)
56

67
# Basic usage
78

@@ -68,6 +69,7 @@ m = editor.Monitor(vlb, visible=True, params={
6869
proj.add_monitor(m)
6970
```
7071

71-
> [!WARNING]
72-
> Loading scripts from the backpack requires a special function: editor.load_script_from_backpack, because the backpack uses a
73-
> slightly different block syntax
72+
!!! Warning
73+
74+
Loading scripts from the backpack requires a special function: editor.load_script_from_backpack, because the backpack uses a
75+
slightly different block syntax

docs/SA-Wiki/Structure-of-the-library.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22

33
Scratchattach consists out of three base classes: `BaseEventHandler`, `BaseSiteComponent` and `BaseCloud`. All classes are grouped in folders based on which base class they are built upon.
44

5-
> [!NOTE]
6-
> The scratchattach.editor module uses its own base classes and is structured separately to the rest of scratchattach. This is possibly subject to change.
5+
!!! Note
6+
7+
The scratchattach.editor module uses its own base classes and is structured separately to the rest of scratchattach. This is possibly subject to change.
78

89
## BaseEventHandler:
910

0 commit comments

Comments
 (0)