A generic LiaScript-Exporter that can export educational content into different formats, so that LiaScript courses can also be utilized in different Learning Management Systems (LMS) or as static documents (PDF, ePub, DOCX, ...). Supported export formats include SCORM 1.2, SCORM 2004, IMS, xAPI, Web, PDF, ePub, DOCX, Android, and more. See the last section LMS Support List

But, it is still the easiest way to share your courses via https://LiaScript.github.io/course/?YOUR_REPO. The LiaScript course website is a fully fledged "offline-first" Progressive Web App (PWA), which allows to store all of your courses and states directly within your browser. If you are coming from Android, you can also directly install the website as an app on your device. Actually, there is no need for a back-end system anymore, but if you need to track the progress of your students, you can use this tool...

The LiaScript-Exporter can be used in three ways:

Download and install the desktop application for your operating system directly from the GitHub Releases page. It provides the same web UI without needing to install Node.js or run any commands — just download, install, and open.

Install Node.js first (it includes npm):

https://nodejs.org/en/download/

Then install the LiaScript-Exporter globally:

npm install -g @liascript/exporter

On Linux you may need sudo:

sudo npm install -g @liascript/exporter

On Windows you may need to run the terminal with administrator privileges.

Then start the local web server:

$ liaex serve

This starts the LiaScript Export Server on port 3000 (default). You can specify a different port:

$ liaex serve --port 8080

The web interface allows you to:

• Upload files or specify a Git repository as your project source
• Select an export target (Moodle, ILIAS, OPAL, Generic LMS, Web, PDF, ePub, DOCX, xAPI)
• Configure advanced settings for your export
• Queue export jobs and track their status

All exports are processed asynchronously in a queue, with only one export running at a time. After submitting an export, you'll receive a job ID and can track the progress on a status page.

For scripting, automation, or CI/CD pipelines, the exporter can be used directly from the command line. Install the same way as above (Node.js + npm install -g @liascript/exporter), then see Basic CLI usage below.

Android exports require the Android SDK, which can be complex to set up locally. The easiest approach is to use the pre-built Docker image:

docker pull liascript/exporter

Then run an Android export inside the container:

docker run --rm -v $(pwd):/work liascript/exporter \
  liaex -f android \
  -i /work/README.md \
  --android-appId io.github.liascript.mycourse \
  --output /work/output

Alternatively you can build the image yourself from the provided Dockerfile in this repository:

docker build -t liascript/exporter .

Once installed, use liaex or liascript-exporter. Core options:

-h --help     show help
-i --input    input file (Markdown or YAML for projects)
-p --path     path to pack (defaults to the input file's directory)
-o --output   output file name (default: "output"; extension set by format)
-f --format   scorm1.2, scorm2004, ims, web, pdf, epub, docx, xapi,
              android, project, rdf, json, fullJson (default: json)
-s --style    additional CSS to inject
-v --version  print version
-k --key      ResponsiveVoice key for text-to-speech

Format-specific options are documented in the sections below. You can also run liaex --help at any time to see the full list.

If you want to generate a SCORM1.2 conformant package of you LiaScript-course, use the following command:

$ liaex -i project/README.md --format scorm1.2 --output rockOn

..
project/README.md
project/Lizenz.md
..
[17:8:33] SCORM 'Init'
[17:8:33] SCORM 'create /tmp/lia202037-30349-o6yx80.zb0eo/pro/imsmanifest.xml'
[17:8:33] SCORM 'create /tmp/lia202037-30349-o6yx80.zb0eo/pro/metadata.xml'
[17:8:33] SCORM 'create /tmp/lia202037-30349-o6yx80.zb0eo/pro/adlcp_rootv1p2.xsd'
[17:8:33] SCORM 'create /tmp/lia202037-30349-o6yx80.zb0eo/pro/ims_xml.xsd'
[17:8:33] SCORM 'create /tmp/lia202037-30349-o6yx80.zb0eo/pro/imscp_rootv1p1p2.xsd'
[17:8:33] SCORM 'create /tmp/lia202037-30349-o6yx80.zb0eo/pro/imsmd_rootv1p2p1.xsd'
[17:8:33] SCORM 'Archiving /tmp/lia202037-30349-o6yx80.zb0eo/pro to rockOn.zip'
[17:8:34] SCORM 'rockOn.zip 4977779 total bytes'
Done

$ ls
.. rockOn.zip ..

The format is scorm1.2 and the input folder is project/README.md. All the content and sub-folders of this folder is then copied into your SCORM.zip. The name is defined by your output definition and contains the current version number of you course as well as the current date.

Note: SCORM 1.2 is too restrictive for storing data, that is why we currently only support to store location information, all states of quizzes, surveys, etc. will be lost after reload.

Better use SCORM2004 as output

Text 2 Speech --key

If you want to use text2speech, you will have to register your website (where the scorm package will be served) at https://responsivevoice.org/ ... it is free for educational and non commercial purposes. After your registration, you will get a key in the format of KluQksUs. To inject this key into your package, simply add the key as a parameter:

$ liaex -i project/README.md --format scorm1.2 --key KluQksUs --output rockOn
...

Mastery Score --scorm-masteryScore

You can define the percentage of quizzes and surveys a student had to fullfil in order to accomplish or pass the course by adding the --scorm-masteryScore parameter. Just set it to 0 to allow all to pass the course, otherwise choose a value between 0 and 100. All quizzes and surveys are treated equally, thus if your course contains 10 quizzes, every quiz counts as 10%. If you do not set this parameter, a default value of 80 percent is used.

$ liaex -i project/README.md --format scorm1.2 --scorm-masteryScore 0 --output rockOn
...

Other Root --path

If your README is not in the root of your project, you can also use the --path parameter to the directory to be copied into your scorm project. You will still have to use --input to define the main course document, but his has to be relative to path parameter.

--scrom-organization

This parameter simply sets the organization parameter in your SCORM imsmanifest file. All other parameters are taken from the course

--scorm-iframe

Some LMS like ILIAS or OpenOlat seem to have problems with the required startingParameter and will not load SCORM1.2 courses properly. To fix this, this parameter can be used. It tries to run the course within an additional <iframe>.

This output format provides the same settings as scorm1.2, but it allows to store state information within the backend LMS. Currently supported are the states for:

• quizzes
• surveys
• tasks

coding elements currently exceed the max storage capacity, that is why these are not stored at the moment.

$ liaex -i project/README.md --format scorm2004 --output rockOn
..
project/README.md
project/Lizenz.md
..
[12:38:31] SCORM 'Init'
[12:38:31] SCORM 'create /tmp/lia2022114-556265-d2jh0k.odg7e/pro/imsmanifest.xml'
[12:38:31] SCORM 'create /tmp/lia2022114-556265-d2jh0k.odg7e/pro/metadata.xml'
[12:38:31] SCORM 'create /tmp/lia2022114-556265-d2jh0k.odg7e/pro/XMLSchema.dtd'
[12:38:31] SCORM 'create /tmp/lia2022114-556265-d2jh0k.odg7e/pro/adlcp_v1p3.xsd'
[12:38:31] SCORM 'create /tmp/lia2022114-556265-d2jh0k.odg7e/pro/adlnav_v1p3.xsd'
[12:38:31] SCORM 'create /tmp/lia2022114-556265-d2jh0k.odg7e/pro/adlseq_v1p3.xsd'
[12:38:31] SCORM 'create /tmp/lia2022114-556265-d2jh0k.odg7e/pro/datatypes.dtd'
[12:38:31] SCORM 'create /tmp/lia2022114-556265-d2jh0k.odg7e/pro/imscp_v1p1.xsd'
[12:38:31] SCORM 'create /tmp/lia2022114-556265-d2jh0k.odg7e/pro/imsss_v1p0.xsd'
[12:38:31] SCORM 'create /tmp/lia2022114-556265-d2jh0k.odg7e/pro/imsss_v1p0auxresource.xsd'
[12:38:31] SCORM 'create /tmp/lia2022114-556265-d2jh0k.odg7e/pro/imsss_v1p0control.xsd'
[12:38:31] SCORM 'create /tmp/lia2022114-556265-d2jh0k.odg7e/pro/imsss_v1p0delivery.xsd'
[12:38:31] SCORM 'create /tmp/lia2022114-556265-d2jh0k.odg7e/pro/imsss_v1p0limit.xsd'
[12:38:31] SCORM 'create /tmp/lia2022114-556265-d2jh0k.odg7e/pro/imsss_v1p0objective.xsd'
[12:38:31] SCORM 'create /tmp/lia2022114-556265-d2jh0k.odg7e/pro/imsss_v1p0random.xsd'
[12:38:31] SCORM 'create /tmp/lia2022114-556265-d2jh0k.odg7e/pro/imsss_v1p0rollup.xsd'
[12:38:31] SCORM 'create /tmp/lia2022114-556265-d2jh0k.odg7e/pro/imsss_v1p0seqrule.xsd'
[12:38:31] SCORM 'create /tmp/lia2022114-556265-d2jh0k.odg7e/pro/imsss_v1p0util.xsd'
[12:38:31] SCORM 'create /tmp/lia2022114-556265-d2jh0k.odg7e/pro/xml.xsd'
[12:38:31] SCORM 'Archiving /tmp/lia2022114-556265-d2jh0k.odg7e/pro to rockOn.zip'
[12:38:32] SCORM 'rockOn.zip 19588706 total bytes'
Done

$ ls
.. rockOn.zip ..

Minimal examples for SCORM1.2 and SCORM2004 for tested LMS:

IMS Content is a very simplistic packaging format. Which allows you to embed your course different LMS. The standard for the packaging format is defined here.

We currently support the latest v1.1.4 standard.

$ liaex -i project/README.md --format ims --output course
..
project/README.md
project/Lizenz.md
..
6041733 total bytes
archiver has been finalized and the output file descriptor has closed.

$ ls
.. course.zip ..

--ims-indexeddb: By default no states are preserved, which means, if you reload the course, all quiz and coding states are destroyed. By using this option a course is generated, which stores the content within the browsers local indexeddb.

$ liaex -i project/README.md --format ims --output course --ims-indexeddb
..
project/README.md
project/Lizenz.md
..Project settings:

--project-no-meta          Disable the generation of meta information for OpenGraph and Twitter-cards.
--project-no-categories    Disable the filter for categories/tags.
--project-category-blur    Enable this and the categories will be blurred instead of deleted.
--project-generate-pdf     PDFs are automatically generated and added to every card.
6041733 total bytes
archiver has been finalized and the output file descriptor has closed.

$ ls
.. course.zip ..

This format will generate an autonomous & standalone web-project that can be uploaded to any webserver.

$ liaex --format web -i project/README.md -o outputFolder
updating title ...
updating description ...
updating logo ...

All required sources as well as your project are copied into the outputFolder and your course-file will be used as the default course. If you have defined the macros comment and logo within your course, these information will also be injected into the index.html. Such that, if you share your project via facebook or twitter, this information is used to generate preview cards properly.

If you want your site to speak the text out loud, then you will have to add your responsivevoice-key via --key.

--web-zip: Use this parameter to directly bundle all input into a zip file instead of a folder.

--web-iframe: This will put the course into an secondary iframe, which will hide the course-URL (the Markdown-file). Unfortunately, it will not be possible anymore to link from outside to a specific slide.

web-indexeddb: Generate a LiaScript package that will store states persistently. By default, the database is generated uniquely for the packed course. That means, every update will use a new database, which makes sense, if and only if, typos get corrected or content is added to the end of the document. Mixing content and moving quizzes and surveys to different slides might cause some problems in restoring the state. But you can use this parameter with a key:

liaex --format web -i project/README.md -o outputFolder --web-indexeddb someKeyToUse
updating title ...
updating description ...
updating logo ...

Tip: Setting up the Android SDK locally can be complex. The easiest approach is to use the pre-built Docker image — see Docker (Android export) above.

To generate an APK project of your course locally, download the Android SDK and provide the path via the option --android-sdk. Additionally you will have to define an appId via --android-appId, which is in most cases an unique URL (in reverse order) that is pointing to your website/project. This export uses capacitorjs to pack the entire LiaScript runtime environment and your resources into one installable Android apk.

$ liaex -f android \
  -i ../LiaBooks/Arbeitsbuch-Prolog/README.md \
  --android-sdk /home/andre/Android/Sdk \
  --android-appId io.github.liascript.arbeitsbuch-prolog
...
../LiaBooks/Arbeitsbuch-Prolog
../LiaBooks/Arbeitsbuch-Prolog/img
../LiaBooks/Arbeitsbuch-Prolog/img/turtle.png
...
added 401 packages, and audited 402 packages in 34s

23 packages are looking for funding
  run `npm fund` for details

5 moderate severity vulnerabilities

...
✔ Adding native android project in android in 37.13ms
✔ add in 38.39ms
✔ Copying web assets from dist to android/app/src/main/assets/public in 97.33ms
✔ Creating capacitor.config.json in android/app/src/main/assets in 207.60μs
✔ copy android in 100.41ms
✔ Updating Android plugins in 592.70μs
[info] Found 1 Capacitor plugin for android:
       @capacitor-community/[email protected]
✔ update android in 18.04ms
✔ Syncing Gradle in 143.57μs
[success] android platform added!
Follow the Developer Workflow guide to get building:
https://capacitorjs.com/docs/basics/workflow
📦  Capacitor Resources v2.0.5
-----------------------------

Checking files and directories...
 ✓  Processing files for: android
 ✓  Icon file ok (1024x1024)
 ✓  Splash file ok (2732x2732)
 ✓  Output directory ok (resources)

Generating files...
 ✓  Generated icon files for android
 ✓  Generated splash files for android
 ✓  Successfully generated all files
Root path: /tmp/lia202227-209284-1q2g2zd.tn3x

----------------------------------------------

📦  Capacitor resources generated successfully!
...
Currently detected usages in: root project 'android', project ':app', project ':capacitor-android', ...
> Task :app:preBuild UP-TO-DATE
> Task :app:preDebugBuild UP-TO-DATE
> Task :capacitor-android:preBuild UP-TO-DATE
> Task :capacitor-android:preDebugBuild UP-TO-DATE
> Task :capacitor-android:compileDebugAidl NO-SOURCE

Deprecated Gradle features were used in this build, making it incompatible with Gradle 8.0.
Use '--warning-mode all' to show the individual deprecation warnings.
See https://docs.gradle.org/7.0/userguide/command_line_interface.html#sec:command_line_warnings

BUILD SUCCESSFUL in 3s
103 actionable tasks: 103 executed

DONE

$ ls 
... output.apk ...

Note: To achieve better performance and offline capabilities, try to add all resources as local ones to your project (i.e. images, audio,scripts, css).

If you want to preview the result, simply use --android-preview, which will open android-studio

Still a bit experimental

For printing out courses to PDF this package uses puppeteer, which is an entire browser. This blows up the project a bit, but it allows to store also the results of iframes, and to run coding examples. What this export does is basically load the entire course within a single page and run all scripts included, code examples, etc. Videos, iframes, audio, etc. are preserved as screenshots, which provide a link to the original resource.

This format has a --pdf-preview mode, which allows you to inspect your course, which works also with https inputs.

liaex --format pdf --pdf-preview -i https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/00_Einfuehrung.md

There are a couple of tweaks, that you can use, have a look at the following resource:

Puppeteer pdf settings

--pdf-stylesheet

Next to these settings, you can also change the appearance of fonts, colors, etc. with you custom CSS. This can define anything, and you can also overwrite all CSS variables LiaScript is based on.

$ cat custom.css \
:root {
    --color-highlight: 2, 255, 0;
    --color-background: 122, 122, 122;
    --color-border: 0, 0, 0;
    --color-highlight-dark: 0, 0, 0;
    --color-highlight-menu: 0, 0, 0;
    --color-text: 0, 0, 255;
    --global-font-size: 1rem;
    --font-size-multiplier: 2;
}% 
$
$ liaex --format pdf \
  -o example \
  --pdf-stylesheet custom.css \
  -i https://github.com/TUBAF-IfI-LiaScript/VL_ProzeduraleProgrammierung/blob/master/08_Objekte.md

depending on the size of the course, this can take a while, please be patient...

--pdf-theme

If you want to change only the appearance by defining the LiaScript theme, which can be either: default, turquoise, blue, red, yellow.

$ liaex --format pdf \
  -o example \
  --pdf-theme red \
  -i https://github.com/TUBAF-IfI-LiaScript/VL_ProzeduraleProgrammierung/blob/master/08_Objekte.md

depending on the size of the course, this can take a while, please be patient...

--pdf-timeout

You have to be aware, that the PDF generation can be quite time consuming especially for large courses with a lot of scripts and code-snippets to be executed and multimedia to be loaded. puppeteer thus sometimes does not know when the course is ready. If the generation fails, you should try to increase this value, the default is 15000, which means 15 seconds.

$ liaex --format pdf \
  -o example \
  --pdf-timeout 15000 \
  -i https://github.com/TUBAF-IfI-LiaScript/VL_ProzeduraleProgrammierung/blob/master/08_Objekte.md

depending on the size of the course, this can take a while, please be patient...

ePub export generates e-books from your LiaScript course using Puppeteer to render content and the @lesjoursfr/html-to-epub library to produce the ePub file. The output is compatible with most e-readers.

$ liaex -i project/README.md --format epub --epub-title "My Course" --epub-author "Author Name" --output course

Required settings:

--epub-title Title of the book.

--epub-author Author name(s), semicolon-separated for multiple authors.

Optional settings:

--epub-publisher Publisher name.

--epub-cover Path to cover image (absolute path or URL).

--epub-description Book description.

--epub-language Language code in 2 letters (default: en).

--epub-version EPUB version: 2 or 3 (default: 3).

--epub-stylesheet Path to custom CSS file for styling.

--epub-theme LiaScript theme: default, turquoise, blue, red, yellow.

--epub-toc-title Title for table of contents (default: "Table Of Contents").

--epub-hide-toc Hide table of contents in the generated EPUB (default: false).

--epub-timeout Additional wait time for rendering in ms (default: 15000).

--epub-fonts Comma-separated paths to custom font files to embed.

--epub-chapter-title Custom title for the main chapter (default: course title).

--epub-preview Open preview browser for debugging (default: false).

DOCX export generates Microsoft Word documents from your LiaScript course using Puppeteer to render content and the @turbodocx/html-to-docx library. The output is compatible with Microsoft Word 2007+, LibreOffice Writer, and Google Docs.

$ liaex -i project/README.md --format docx --output course

Optional settings:

--docx-title Title of the document.

--docx-author Author / creator of the document.

--docx-subject Subject of the document.

--docx-description Description of the document.

--docx-language Language code for spell checker (default: en-US).

--docx-orientation Page orientation: portrait or landscape (default: portrait).

--docx-font Font name (default: Arial).

--docx-font-size Font size in half-points/HIP (default: 22, equals 11pt).

--docx-header Enable header in the document (default: false).

--docx-header-html Custom HTML string for the header.

--docx-footer Enable footer in the document (default: false).

--docx-footer-html Custom HTML string for the footer.

--docx-page-number Add page numbers to the footer (default: false).

--docx-stylesheet Path to a local CSS file to inject before export.

--docx-theme LiaScript theme: default, turquoise, blue, red, yellow.

--docx-timeout Additional wait time after rendering in ms (default: 15000).

--docx-preview Open preview browser for debugging (default: false).

xAPI (Experience API / Tin Can API) is a standard for tracking learning experiences and interactions with a Learning Record Store (LRS). The exporter generates a self-contained web package with a tincan.xml manifest.

$ liaex -i project/README.md --format xapi --output course

--xapi-endpoint URL of the Learning Record Store (LRS) endpoint.

--xapi-auth Authentication string for the LRS (e.g., "Basic dXNlcm5hbWU6cGFzc3dvcmQ=").

--xapi-actor JSON string representing the xAPI actor (default: anonymous).

--xapi-course-id Custom identifier for the course (default: course URL).

--xapi-course-title Custom title for the course (default: from document).

--xapi-mastery-threshold Score threshold for mastery (default: 0.8).

--xapi-progress-threshold Score threshold for progress (default: 0.9).

--xapi-debug Enable debug logging for xAPI statements.

--xapi-zip Package the output as a zip file.

Projects are a way to bundle a collection of courses and to make a custom overview page for it.

The input has to be a yaml file that looks like the following one:

title: >
  <span style="background-color: rgba(0,106,179,0.75); padding: 5px; color: white">
    My personal OER - collection
  </span>

comment: >
  This is used as a subtitle or as a description of your page

logo: https://upload.wikimedia.org/wikipedia/commons/thumb/8/81/Universitaetsbibliothek_Freiberg_Fassade.jpg/1024px-Universitaetsbibliothek_Freiberg_Fassade.jpg

icon: https://upload.wikimedia.org/wikipedia/commons/thumb/d/de/Logo_TU_Bergakademie_Freiberg.svg/242px-Logo_TU_Bergakademie_Freiberg.svg.png

footer: >
  Simply add a custom footer - that can also contain HTML
  <a href="proxy.php?url=https%3A%2F%2Fliascript.github.io" target="_blank">Made with LiaScript</a>

# With this settings you can customize social metadata, og-graph for facebook or twitter
# if not present, the title, comment, and logo will be used.
# You can explicitly turn this of with the cmd-parameter --project-no-meta
meta:
  title: OER-Collection
  description: Sammlung der OER Inhalte der Arbeitsgruppe Softwareentwicklung und Robotik (TU Freiberg)
  #image: url

# A collection is where you put all your courses into, all information, such as title, comment, logo, etc.
# will be taken from the links that you provide ...
collection:

  - url: https://raw.githubusercontent.com/LiaScript/docs/master/README.md
  - url: https://raw.githubusercontent.com/LiaBooks/LiaScript-Tutorial/main/README.md
  - url: https://raw.githubusercontent.com/LiaPlayground/LiaScript_WeAreDevelopers2022/main/README.md

  # Additionally it is possible to manually overwrite parameters
  - url: https://raw.githubusercontent.com/LiaPlayground/LiaScript_Tutorial_Kigali/main/README.md
    title: eLearning Africa Workshop 2022
    comment: Shows only an introduction, please follow the links within the course.
    # logo: https://another_image.jpg
    # or leave, so that no card-image is added to your preview-cards
    # logo: 

    # You can manually tag courses, if this has not been done within the main comment of the course.
    # By default, these tags will be treated as categories, which can be used to navigate through
    # your courses. To disable this, use the cmd-param --project-no-categories
    # 
    # For smaller overviews, you can also use the --project-category-blur parameter.
    # this will not hide the courses, that do not match, but instead blur them.
    tags:
      - Tutorial
      - LiaScript
      - OER

  - html: >
      <hr>
      <h1>Some content in between</h1>
      
      <p>You can add additional content in between to group your course collections or provide more information.</p>

  # If you want to group multiple courses into one sub-collection, then instead of an "-url:"
  # define another `collection`. All parameters can be changed as above. Additionally you can switch of images or comments,
  # just by adding an empty attribute. And, it is also possible to add tags to every sub-course.
  - title: Prozedurale Programmierung
    comment: todo
    collection:
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_ProzeduraleProgrammierung/master/00_Einfuehrung.md
        #title: Rename the current course
        #logo: Manually set an logo
        #comment: Add a custom description, this will overwrite the comment within the course
        # tags will be used for navigation and searching
        #tags: 
        # - C++
        # - Programmierung
        # - Hardware
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_ProzeduraleProgrammierung/master/01_EingabeAusgabeDatentypen.md
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_ProzeduraleProgrammierung/master/02_OperatorenKontrollstrukturen.md
      #- url: ...

  # HTML content can be placed between cards
  - html: >
      <hr>
      <h1>Softwareentwicklung</h1>
      
      <p>todo</p>

  - title: Softwareentwicklung
    comment: Todo
    grid: true # if you have larger collections and you want them to appear in a grid and not in a row, with some
               # hidden content, then set the grid-parameter to true.
    collection:
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/00_Einfuehrung.md
        logo: # this is used to empty the default image icon
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/01_Software.md
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/02_DotNet.md
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/03_CsharpGrundlagenI.md
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/04_CsharpGrundlagenII.md
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/05_CsharpGrundlagenIII.md
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/06_ProgrammflussUndFunktionen.md
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/07_OOPGrundlagenI.md
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/08_OOPGrundlagenII.md
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/09_Vererbung.md
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/10_AbstrakteKlassenUndInterfaces.md
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/11_VersionsverwaltungI.md
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/12_VersionsverwaltungII.md
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/13_UML_Modellierung.md
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/14_UML_ModellierungII.md
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/15_UML_ModellierungIII.md
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/16_Testen.md
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/17_Dokumentation_BuildTools.md
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/18_ContinuousIntegration.md
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/19_Generics.md
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/20_Container.md
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/21_Delegaten.md
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/22_Events.md
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/23_Threads.md
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/24_Tasks.md
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/25_LINQ.md
      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/26_DesignPattern.md
        arguments:
          - pdf-format: A3
          - project-generate-scorm2004: true
          - scorm-organization: TU-Bergakademie Freiberg

      - url: https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_Softwareentwicklung/master/27_Anwendungen.md
        arguments:
          - project-generate-pdf: false

Basic usage:

liaex -i curriculum.yml --format project

If you want to add precompiled pdf to every course, then you simply have to add the --project-generate-pdf command. Additionally, you can pass any pdf settings to customize the pdf output.

liaex -i curriculum.yml --format project --project-generate-pdf --pdf-format A4

As it is depicted in the last part of the yaml file above, you can manually set or change all parameters. Such as, for which projects you want to generate a pdf and pass also all additional parameters. Simply pass all arguments as arguments with the long name and without the starting dashes. This way you can generate a very detailed project configuration and overview.

The LiaScript metainformation can be exported to RDF, either as json-ld or as n-quads. The option --pdf-preview generates a console output that can be used to inspect the result. Otherwise the result is stored in a file, defined by -o, the file-ending is either .jsonld or .nq, depending on the --rdf-format

liaex --format rdf --rdf-preview -i https://raw.githubusercontent.com/liaScript/docs/master/README.md

{
  "@context": "http://schema.org",
  "@id": "https://raw.githubusercontent.com/liaScript/docs/master/README.md",
  "@type": "Course",
  "author": {
    "@type": "Person",
    "email": "[email protected]",
    "name": "André Dietrich"
  },
  "description": "This document shall provide an entire compendium and course on the development of Open-courSes with [LiaScript](https://LiaScript.github.io). As the language and the systems grows, also this document will be updated. Feel free to fork or copy it, translations are very welcome...",
  "image": {
    "@type": "ImageObject",
    "url": "https://liascript.github.io/img/bg-showcase-1.jpg"
  },
  "inLanguage": "en",
  "name": "LiaScript",
  "url": "https://LiaScript.github.io/course/?https://raw.githubusercontent.com/liaScript/docs/master/README.md",
  "version": "22.0.2"
}

The result as n-quads looks like this:

liaex --format rdf --rdf-preview --rdf-format n-quads -i https://raw.githubusercontent.com/liaScript/docs/master/README.md

<https://raw.githubusercontent.com/liaScript/docs/master/README.md> <http://schema.org/author> _:b0 .
<https://raw.githubusercontent.com/liaScript/docs/master/README.md> <http://schema.org/description> "This document shall provide an entire compendium and course on the development of Open-courSes with [LiaScript](https://LiaScript.github.io). As the language and the systems grows, also this document will be updated. Feel free to fork or copy it, translations are very welcome..." .
<https://raw.githubusercontent.com/liaScript/docs/master/README.md> <http://schema.org/image> _:b1 .
<https://raw.githubusercontent.com/liaScript/docs/master/README.md> <http://schema.org/inLanguage> "en" .
<https://raw.githubusercontent.com/liaScript/docs/master/README.md> <http://schema.org/name> "LiaScript" .
<https://raw.githubusercontent.com/liaScript/docs/master/README.md> <http://schema.org/url> "https://LiaScript.github.io/course/?https://raw.githubusercontent.com/liaScript/docs/master/README.md" .
<https://raw.githubusercontent.com/liaScript/docs/master/README.md> <http://schema.org/version> "22.0.2" .
<https://raw.githubusercontent.com/liaScript/docs/master/README.md> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://schema.org/Course> .
_:b0 <http://schema.org/email> "[email protected]" .
_:b0 <http://schema.org/name> "André Dietrich" .
_:b0 <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://schema.org/Person> .
_:b1 <http://schema.org/url> "https://liascript.github.io/img/bg-showcase-1.jpg" .
_:b1 <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://schema.org/ImageObject> .

If you are working on a local repository and you want to add the remote URL, you can specify --rdf-url and run it with a local file as input:

liaex --format rdf --rdf-preview -i ../LiaBooks/docs/README.md --rdf-url https://raw.githubusercontent.com/liaScript/docs/master/README.md

{
  "@context": "http://schema.org",
  "@id": "https://raw.githubusercontent.com/liaScript/docs/master/README.md",
  "@type": "Course",
  "author": {
    "@type": "Person",
    "email": "[email protected]",
    "name": "André Dietrich"
  },
  "description": "This document shall provide an entire compendium and course on the development of Open-courSes with [LiaScript](https://LiaScript.github.io). As the language and the systems grows, also this document will be updated. Feel free to fork or copy it, translations are very welcome...",
  "image": {
    "@type": "ImageObject",
    "url": "https://liascript.github.io/img/bg-showcase-1.jpg"
  },
  "inLanguage": "en",
  "name": "LiaScript",
  "url": "https://LiaScript.github.io/course/?https://raw.githubusercontent.com/liaScript/docs/master/README.md",
  "version": "22.0.2"
}

Local course but without --rdf-url

liaex --format rdf --rdf-preview -i ../LiaBooks/docs/README.md

{
  "@context": "http://schema.org",
  "@type": "Course",
  "author": {
    "@type": "Person",
    "email": "[email protected]",
    "name": "André Dietrich"
  },
  "description": "This document shall provide an entire compendium and course on the development of Open-courSes with [LiaScript](https://LiaScript.github.io). As the language and the systems grows, also this document will be updated. Feel free to fork or copy it, translations are very welcome...",
  "image": {
    "@type": "ImageObject",
    "url": "https://liascript.github.io/img/bg-showcase-1.jpg"
  },
  "inLanguage": "en",
  "name": "LiaScript",
  "version": "22.0.2"
}

• --rdf-type: By default this type of resource is associated with Course, but you can use this param if you want to define EducationalResource or something else...
• --rdf-educationalLevel: This is currently not defined, but can be injected, typically these are beginner, intermediate, advanced, ...
• --rdf-license: Use this to specify the URL of the associated license to your course. This tool will automatically check if there is a LICENSE file in your project root and add this.

<!--
author: Your Name
email: [email protected]
comment: Some basic information about your course
version: 12.0.2
logo: https://someimageURL.jpg
tags: keyword 1, keyword 2, keyword 3
language: en
-->

# Title of the course
...

This will be translated to:

{
  "@context": "http://schema.org",
  "@id": "https://raw.githubusercontent.com/.../master/README.md",
  "@type": "Course",
  "author": {
    "@type": "Person",
    "email": "[email protected]",
    "name": "Your Name"
  },
  "description": "Some basic information about your course",
  "image": {
    "@type": "ImageObject",
    "url": "https://someimageURL.jpg"
  },
  "inLanguage": "en",
  "name": "Title of the course",
  "url": "https://LiaScript.github.io/course/?https://raw.githubusercontent.com/.../master/README.md",
  "version": "12.0.2",
  "keywords": [
    "keyword 1",
    "keyword 2",
    "keyword 3"
  ]
}

Export your LiaScript courses directly in GitHub workflows with this GitHub Action.

Add to your .github/workflows/export.yml:

name: Export Course
on: [push]

jobs:
  export:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    
    - name: Export to SCORM
      uses: LiaScript/LiaScript-Exporter@master
      with:
        input-file: 'README.md'
        format: 'scorm1.2'
        output-name: 'my-course'
        scorm-organization: 'My Organization'
    
    - name: Upload SCORM package
      uses: actions/upload-artifact@v4
      with:
        name: scorm-package
        path: '*.zip'

For complete GitHub Action documentation, inputs, outputs, and more examples, see: action/README.md

If you are interested in creating integrations for other systems, you can define custom connectors for your target system. They are located at src/javascript/connectors. Each connector is a simple class that inherits from Base/Connector and overrides the relevant methods for the target system.

Most of the data is taken from:

• https://www.ispringsolutions.com/supported-lms
• https://en.wikipedia.org/wiki/List_of_learning_management_systems