Skip to content

Commit 741190e

Browse files
andre-dietrichandre-dietrich
committed
Initial commit
0 parents  commit 741190e

13 files changed

Lines changed: 392 additions & 0 deletions

‎.github/workflows/build.yaml‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
name: Generate LiaScript Outputs
2+
3+
# Trigger: Run the workflow when changes are pushed to the 'main' branch.
4+
on:
5+
push:
6+
branches:
7+
- main
8+
9+
permissions:
10+
contents: write
11+
12+
jobs:
13+
generate:
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
# Step 1: Check out the repository's code to project directory.
18+
- name: Checkout Repository
19+
uses: actions/checkout@v4
20+
with:
21+
path: project
22+
23+
# Step 2: Set up Node.js environment.
24+
- name: Set up Node.js
25+
uses: actions/setup-node@v3
26+
with:
27+
node-version: '22' # Specify the Node.js version.
28+
29+
# Step 3: Install the LiaScript exporter globally using npm.
30+
- name: Install LiaScript Exporter
31+
run: |
32+
npm install -g @liascript/exporter
33+
34+
# Step 4: Generate a PDF from README.md.
35+
- name: Generate PDF
36+
run: |
37+
liaex -i project/README.md --format pdf --output press --pdf-timeout 50000
38+
39+
# Step 5: Generate a SCORM package.
40+
- name: Generate SCORM
41+
run: |
42+
liaex -i project/README.md -f scorm1.2 --scorm-masteryScore 80 --scorm-embed --output SCORM
43+
44+
# Step 6: Generate an IMS package.
45+
- name: Generate IMS Package
46+
run: |
47+
liaex -i project/README.md --format ims --output IMS
48+
49+
# Step 7: Create a new GitHub release for the generated assets.
50+
- name: Create New Release
51+
id: create_release
52+
uses: actions/create-release@v1
53+
env:
54+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
55+
with:
56+
tag_name: 'latest'
57+
release_name: 'Latest LiaScript Documentation'
58+
draft: false
59+
prerelease: false
60+
61+
# Step 8: Upload the generated PDF as a release asset.
62+
- name: Upload PDF as Release Asset
63+
uses: actions/upload-release-asset@v1
64+
env:
65+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
66+
with:
67+
upload_url: ${{ steps.create_release.outputs.upload_url }}
68+
asset_path: press.pdf
69+
asset_name: press.pdf
70+
asset_content_type: application/pdf
71+
72+
# Step 9: Upload the generated SCORM package.
73+
- name: Upload SCORM as Release Asset
74+
uses: actions/upload-release-asset@v1
75+
env:
76+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
77+
with:
78+
upload_url: ${{ steps.create_release.outputs.upload_url }}
79+
asset_path: SCORM.zip
80+
asset_name: SCORM.zip
81+
asset_content_type: application/zip
82+
83+
# Step 10: Upload the generated IMS package.
84+
- name: Upload IMS as Release Asset
85+
uses: actions/upload-release-asset@v1
86+
env:
87+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
88+
with:
89+
upload_url: ${{ steps.create_release.outputs.upload_url }}
90+
asset_path: IMS.zip
91+
asset_name: IMS.zip
92+
asset_content_type: application/zip

‎LICENSE‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
Creative Commons Legal Code
2+
3+
CC0 1.0 Universal
4+
5+
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
6+
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
7+
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
8+
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
9+
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
10+
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
11+
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
12+
HEREUNDER.
13+
14+
Statement of Purpose
15+
16+
The laws of most jurisdictions throughout the world automatically confer
17+
exclusive Copyright and Related Rights (defined below) upon the creator
18+
and subsequent owner(s) (each and all, an "owner") of an original work of
19+
authorship and/or a database (each, a "Work").
20+
21+
Certain owners wish to permanently relinquish those rights to a Work for
22+
the purpose of contributing to a commons of creative, cultural and
23+
scientific works ("Commons") that the public can reliably and without fear
24+
of later claims of infringement build upon, modify, incorporate in other
25+
works, reuse and redistribute as freely as possible in any form whatsoever
26+
and for any purposes, including without limitation commercial purposes.
27+
These owners may contribute to the Commons to promote the ideal of a free
28+
culture and the further production of creative, cultural and scientific
29+
works, or to gain reputation or greater distribution for their Work in
30+
part through the use and efforts of others.
31+
32+
For these and/or other purposes and motivations, and without any
33+
expectation of additional consideration or compensation, the person
34+
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
35+
is an owner of Copyright and Related Rights in the Work, voluntarily
36+
elects to apply CC0 to the Work and publicly distribute the Work under its
37+
terms, with knowledge of his or her Copyright and Related Rights in the
38+
Work and the meaning and intended legal effect of CC0 on those rights.
39+
40+
1. Copyright and Related Rights. A Work made available under CC0 may be
41+
protected by copyright and related or neighboring rights ("Copyright and
42+
Related Rights"). Copyright and Related Rights include, but are not
43+
limited to, the following:
44+
45+
i. the right to reproduce, adapt, distribute, perform, display,
46+
communicate, and translate a Work;
47+
ii. moral rights retained by the original author(s) and/or performer(s);
48+
iii. publicity and privacy rights pertaining to a person's image or
49+
likeness depicted in a Work;
50+
iv. rights protecting against unfair competition in regards to a Work,
51+
subject to the limitations in paragraph 4(a), below;
52+
v. rights protecting the extraction, dissemination, use and reuse of data
53+
in a Work;
54+
vi. database rights (such as those arising under Directive 96/9/EC of the
55+
European Parliament and of the Council of 11 March 1996 on the legal
56+
protection of databases, and under any national implementation
57+
thereof, including any amended or successor version of such
58+
directive); and
59+
vii. other similar, equivalent or corresponding rights throughout the
60+
world based on applicable law or treaty, and any national
61+
implementations thereof.
62+
63+
2. Waiver. To the greatest extent permitted by, but not in contravention
64+
of, applicable law, Affirmer hereby overtly, fully, permanently,
65+
irrevocably and unconditionally waives, abandons, and surrenders all of
66+
Affirmer's Copyright and Related Rights and associated claims and causes
67+
of action, whether now known or unknown (including existing as well as
68+
future claims and causes of action), in the Work (i) in all territories
69+
worldwide, (ii) for the maximum duration provided by applicable law or
70+
treaty (including future time extensions), (iii) in any current or future
71+
medium and for any number of copies, and (iv) for any purpose whatsoever,
72+
including without limitation commercial, advertising or promotional
73+
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
74+
member of the public at large and to the detriment of Affirmer's heirs and
75+
successors, fully intending that such Waiver shall not be subject to
76+
revocation, rescission, cancellation, termination, or any other legal or
77+
equitable action to disrupt the quiet enjoyment of the Work by the public
78+
as contemplated by Affirmer's express Statement of Purpose.
79+
80+
3. Public License Fallback. Should any part of the Waiver for any reason
81+
be judged legally invalid or ineffective under applicable law, then the
82+
Waiver shall be preserved to the maximum extent permitted taking into
83+
account Affirmer's express Statement of Purpose. In addition, to the
84+
extent the Waiver is so judged Affirmer hereby grants to each affected
85+
person a royalty-free, non transferable, non sublicensable, non exclusive,
86+
irrevocable and unconditional license to exercise Affirmer's Copyright and
87+
Related Rights in the Work (i) in all territories worldwide, (ii) for the
88+
maximum duration provided by applicable law or treaty (including future
89+
time extensions), (iii) in any current or future medium and for any number
90+
of copies, and (iv) for any purpose whatsoever, including without
91+
limitation commercial, advertising or promotional purposes (the
92+
"License"). The License shall be deemed effective as of the date CC0 was
93+
applied by Affirmer to the Work. Should any part of the License for any
94+
reason be judged legally invalid or ineffective under applicable law, such
95+
partial invalidity or ineffectiveness shall not invalidate the remainder
96+
of the License, and in such case Affirmer hereby affirms that he or she
97+
will not (i) exercise any of his or her remaining Copyright and Related
98+
Rights in the Work or (ii) assert any associated claims and causes of
99+
action with respect to the Work, in either case contrary to Affirmer's
100+
express Statement of Purpose.
101+
102+
4. Limitations and Disclaimers.
103+
104+
a. No trademark or patent rights held by Affirmer are waived, abandoned,
105+
surrendered, licensed or otherwise affected by this document.
106+
b. Affirmer offers the Work as-is and makes no representations or
107+
warranties of any kind concerning the Work, express, implied,
108+
statutory or otherwise, including without limitation warranties of
109+
title, merchantability, fitness for a particular purpose, non
110+
infringement, or the absence of latent or other defects, accuracy, or
111+
the present or absence of errors, whether or not discoverable, all to
112+
the greatest extent permissible under applicable law.
113+
c. Affirmer disclaims responsibility for clearing rights of other persons
114+
that may apply to the Work or any use thereof, including without
115+
limitation any person's Copyright and Related Rights in the Work.
116+
Further, Affirmer disclaims responsibility for obtaining any necessary
117+
consents, permissions or other rights required for any use of the
118+
Work.
119+
d. Affirmer understands and acknowledges that Creative Commons is not a
120+
party to this document and has no duty or obligation with respect to
121+
this CC0 or use of the Work.

‎README.md‎

Lines changed: 179 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,179 @@
1+
<!--
2+
3+
author: André Dietrich
4+
5+
email: LiaScript@web.de
6+
7+
comment: LiaScript introduces itself in an interactive way.
8+
9+
version: 0.0.1
10+
11+
mode: Slides
12+
13+
import: https://raw.githubusercontent.com/liaTemplates/ABCjs/main/README.md
14+
15+
@style
16+
@keyframes burn {
17+
0% { text-shadow: 0 0 5px #ff0, 0 0 10px #ff0, 0 0 15px #f00, 0 0 20px #f00, 0 0 25px #f00, 0 0 30px #f00, 0 0 35px #f00;
18+
}
19+
50% { text-shadow: 0 0 10px #ff0, 0 0 15px #ff0, 0 0 20px #ff0, 0 0 25px #f00, 0 0 30px #f00, 0 0 35px #f00, 0 0 40px #f00;
20+
}
21+
100% { text-shadow: 0 0 5px #ff0, 0 0 10px #ff0, 0 0 15px #f00, 0 0 20px #f00, 0 0 25px #f00, 0 0 30px #f00, 0 0 35px #f00;
22+
}
23+
}
24+
25+
.burning-text {
26+
font-weight: bold;
27+
color: #fff;
28+
animation: burn 1.5s infinite alternate;
29+
}
30+
@end
31+
32+
@burn: <span class="burning-text">@0</span>
33+
34+
-->
35+
36+
37+
# Hello LiaScript
38+
39+
--{{0}}--
40+
Hello, my name is LiaScript, I am a Markdown-based language that has been specially developed to create educational materials. The advantage of Markdown is that it is already widely used, easy to write and read, and supported by many platforms. The biggest drawback, however, is that it is @burn(static as hell) and offers no interactivity.
41+
!?[⏯](media/liascript_0.webm)
42+
43+
44+
45+
--{{1}}--
46+
So my creators set out to rethink Markdown from the ground up...
47+
!?[⏯](media/liascript_1.webm)
48+
49+
{{1-2}}
50+
> <marquee>... Once you free your mind about a concept of Harmony and of music being "correct" you can do whatever you want ...</marquee>
51+
>
52+
> -- Giorgio Moroder (inventor of disco music)
53+
54+
55+
56+
--{{2}}--
57+
Actually, tables in Markdown are simple to create and, as mentioned, are quite @burn(static). However, a table can also represent a dataset that strives for its ideal visualization.
58+
!?[⏯](media/liascript_2.webm)
59+
60+
{{2}}
61+
| Animal | Weight in kg | Lifespan (years) | Mitogen |
62+
| --------------- | -----------: | ---------------: | ------: |
63+
| Mouse | 0.028 | 02 | 95 |
64+
| Flying Squirrel | 0.085 | 15 | 50 |
65+
| Brown Bat | 0.020 | 30 | 10 |
66+
| Sheep | 90 | 12 | 95 |
67+
| Human | 68 | 70 | 10 |
68+
69+
70+
71+
--{{3}}--
72+
Another tabular structure can produce a different visualization that can be fine-tuned by the creator. In total, I support 10 different types of visualizations.
73+
!?[⏯](media/liascript_3.webm)
74+
75+
{{3}}
76+
<!--
77+
data-type="heatmap"
78+
data-title="Seattle Average Temperature in Fahrenheit"
79+
data-show
80+
-->
81+
| Seattle | Jan | Feb | Mar | Apr | May | Jun | Jul | Aug | Sep | Oct | Nov | Dec |
82+
| -------:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:|
83+
| 0 | 40.7 | 41.5 | 43.6 | 46.6 | 51.4 | 56.0 | 60.5 | 61.2 | 57.0 | 50.1 | 44.1 | 39.6 |
84+
| 2 | 40.2 | 40.7 | 42.7 | 45.3 | 50.0 | 54.4 | 58.5 | 59.2 | 55.4 | 49.2 | 43.5 | 39.3 |
85+
| 4 | 39.7 | 40.0 | 41.9 | 44.4 | 48.9 | 53.2 | 57.0 | 57.7 | 54.2 | 48.6 | 43.1 | 38.9 |
86+
| 6 | 39.6 | 39.5 | 41.3 | 44.2 | 49.5 | 54.2 | 57.8 | 57.4 | 53.6 | 48.2 | 42.8 | 38.7 |
87+
| 8 | 39.6 | 39.9 | 42.9 | 47.1 | 52.7 | 57.3 | 61.3 | 61.1 | 56.7 | 49.5 | 43.1 | 38.7 |
88+
| 10 | 41.3 | 42.7 | 46.4 | 50.7 | 56.4 | 60.9 | 65.2 | 65.4 | 60.9 | 52.8 | 45.5 | 40.4 |
89+
| 12 | 43.8 | 46.0 | 49.5 | 53.8 | 59.6 | 64.3 | 69.4 | 69.8 | 65.1 | 56.0 | 47.8 | 42.6 |
90+
| 14 | 45.1 | 47.7 | 51.3 | 55.9 | 61.9 | 66.9 | 72.6 | 73.2 | 67.7 | 57.8 | 48.8 | 43.6 |
91+
| 16 | 44.5 | 47.5 | 51.4 | 55.9 | 62.3 | 67.5 | 73.9 | 74.3 | 68.2 | 57.4 | 47.8 | 42.6 |
92+
| 18 | 42.6 | 44.7 | 48.7 | 53.8 | 60.3 | 65.9 | 72.3 | 72.2 | 64.6 | 53.9 | 46.0 | 41.2 |
93+
| 20 | 42.0 | 43.3 | 46.4 | 50.2 | 56.0 | 61.4 | 66.9 | 66.6 | 60.7 | 52.3 | 45.2 | 40.7 |
94+
| 22 | 41.4 | 42.5 | 45.0 | 48.3 | 53.5 | 58.2 | 63.2 | 63.5 | 58.7 | 51.1 | 44.5 | 40.1 |
95+
96+
97+
98+
--{{4}}--
99+
What Markdown has always lacked was the embedding of multimedia content ...
100+
!?[⏯](media/liascript_4.webm)
101+
102+
103+
104+
--{{5}}--
105+
I support audio content ...
106+
!?[⏯](media/liascript_5.webm)
107+
108+
{{5-6}}
109+
?[a horse](https://www.w3schools.com/html/horse.mp3 "hear a horse")
110+
111+
112+
113+
--{{6}}--
114+
I can handle video as well, and of course, I work on feature phones even if they are offline.
115+
!?[⏯](media/liascript_6.webm)
116+
117+
{{6-7}}
118+
!?[LiaScript on Nokia](https://www.youtube.com/watch?v=U_UW69w0uHE)
119+
120+
121+
122+
--{{7}}--
123+
I can also try to embed other types of content that do not fall into either of the two categories
124+
!?[⏯](media/liascript_7.webm)
125+
126+
{{7}}
127+
??[Esther’s scroll in a cover](https://sketchfab.com/3d-models/esthers-scroll-in-a-cover-21a13eba33cb4343bab56f0c0f982876 "Historical Museum of the City of Kraków")
128+
129+
130+
131+
--{{8}}--
132+
And much, much more... We will soon show you how everything works.
133+
!?[⏯](media/liascript_8.webm)
134+
135+
{{8}}
136+
```abc
137+
X: 1
138+
M: 4/4
139+
L: 1/8
140+
K: Emin
141+
|:D2|"Em"EBBA B2 EB|~B2 AB dBAG|"D"FDAD BDAD|FDAD dAFD|
142+
"Em"EBBA B2 EB|B2 AB defg|"D"afe^c dBAF|"Em"DEFD E2:|
143+
```
144+
@ABCJS.eval
145+
146+
147+
148+
--{{9}}--
149+
You might have noticed that this document is being used like a PowerPoint presentation. However, our intention was to utilize LiaScript in various contexts. With LiaScript, you can create presentations, enable self-study through browser-based text-to-speech output, or read the content as a simple yet interactive textbook, without animations.
150+
!?[⏯](media/liascript_9.webm)
151+
152+
{{9}}
153+
> ## Quiz?
154+
>
155+
> __Will you use LiaScript in the future?__
156+
>
157+
> - [(X)] Yes of course
158+
> - [( )] not sure ...
159+
> - [( )] No, I prefer to use a classical LMS
160+
161+
162+
163+
## More Information
164+
165+
- __Website:__ https://LiaScript.github.io
166+
- __Documentation:__
167+
https://liascript.github.io/course/?https://raw.githubusercontent.com/liaScript/docs/master/README.md
168+
- __YouTube:__ https://www.youtube.com/@liascript4180
169+
- __Blog:__ https://LiaScript.github.io/blog
170+
- __LiveEditor:__
171+
172+
- https://liascript.github.io/LiveEditor
173+
- https://liascript.github.io/LiveEditor/examples.html
174+
175+
- __GitHub:__
176+
177+
- Project: https://github.com/^superscript^
178+
- Courses: https://github.com/topics/liascript-course
179+
- Templates: https://github.com/topics/liascript-template

‎media/liascript_0.webm‎

2.16 MB
Binary file not shown.

‎media/liascript_1.webm‎

503 KB
Binary file not shown.

‎media/liascript_2.webm‎

1.28 MB
Binary file not shown.

‎media/liascript_3.webm‎

1.24 MB
Binary file not shown.

‎media/liascript_4.webm‎

602 KB
Binary file not shown.

‎media/liascript_5.webm‎

347 KB
Binary file not shown.

‎media/liascript_6.webm‎

729 KB
Binary file not shown.

0 commit comments

Comments
 (0)