Skip to content

Commit 192bec1

Browse files
Add edit macro section
1 parent 6d44a95 commit 192bec1

File tree

2 files changed

+28
-3
lines changed

2 files changed

+28
-3
lines changed

README.md

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22
33
author: André Dietrich
44
5-
date: 14/04/2025
6-
version: 31.0.0
5+
date: 11/06/2025
6+
version: 32.0.0
77
language: en
88
narrator: UK English Female
99
10+
edit: true
11+
1012
repository: https://github.com/LiaScript/docs
1113
1214
logo: img/logo.png
@@ -34,7 +36,6 @@ font: Noto Sans Egyptian Hieroglyphs, Noto Sans Ogham
3436

3537
# LiaScript
3638

37-
3839
> To see this document as an interactive LiaScript rendered version, click on the
3940
> following link/badge:
4041
>
@@ -9356,6 +9357,30 @@ email: [email protected]
93569357

93579358
![Email information](img/email.png)
93589359

9360+
##### `edit`
9361+
9362+
--{{0}}--
9363+
This macro allows you to define an edit link for your course.
9364+
It can be used to point to a specific location in your repository where users can suggest changes or improvements.
9365+
9366+
```md
9367+
<!--
9368+
edit: https://github.dev/LiaScript/docs/main/README.md
9369+
-->
9370+
```
9371+
![Edit information](img/edit.png)
9372+
9373+
--{{1}}--
9374+
Or if you set this to `true`, it will automatically link to the current document to the [live editor](https://liascript.github.io/LiveEditor).
9375+
This comes especially handy if you want user to inspect the code, such as it is, if you have developed a template.
9376+
9377+
{{1}}
9378+
```md
9379+
<!--
9380+
edit: true
9381+
-->
9382+
```
9383+
93599384
##### `logo`
93609385

93619386
--{{0}}--

img/edit.png

34.5 KB
Loading

0 commit comments

Comments
 (0)