You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+58Lines changed: 58 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -71,6 +71,10 @@ The web interface allows you to:
71
71
72
72
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.
73
73
74
+
> **Note:** the **Git repository** source (in both the desktop app and the web
75
+
> UI) requires [`git`](https://git-scm.com/downloads) to be installed and
76
+
> available on your `PATH`. Uploading files does not need git.
77
+
74
78
### 3. CLI
75
79
76
80
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`).
@@ -87,11 +91,65 @@ Once installed, use `liaex` or `liascript-exporter`. Core options:
87
91
-s --style additional CSS to inject
88
92
-v --version print version
89
93
-k --key ResponsiveVoice key for text-to-speech
94
+
95
+
--git-url clone a git/GitHub repository and export from it (used instead of -i)
96
+
--git-branch branch or tag to checkout (default: repository default)
97
+
--git-subdir subdirectory within the repository to use as the root
98
+
--git-file specific markdown file to export (default: README.md or first .md found)
90
99
```
91
100
92
101
Format-specific options are documented in the sections below. You can also run
93
102
`liaex --help` at any time to see the full list.
94
103
104
+
### Export from a Git repository
105
+
106
+
Instead of pointing `-i` at a local file, you can let the exporter clone a
107
+
repository and export directly from it with `--git-url`. The repo is cloned to a
108
+
temporary directory and removed automatically when the export finishes.
109
+
110
+
> **Note:** this requires [`git`](https://git-scm.com/downloads) to be installed
111
+
> and available on your `PATH`.
112
+
113
+
``` bash
114
+
# Export the README.md of a repository to SCORM 2004
0 commit comments