archives/tweego
2
0
Fork 0
mirror of https://github.com/tmedwards/tweego.git synced 2025-07-06 14:40:38 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: add ESM (.mjs) file support (#57)

Browse source 
resolves: #53
This commit is contained in:
Thomas M. Edwards 2023-11-06 13:09:21 -06:00 • committed by GitHub
parent 9f43ea0976
commit aba7e432ea
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 32 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/core/usage.md
View file

@ -58,7 +58,7 @@ Where <code>[options]</code> are mostly optional configuration flags—see [Opti
<p>Log various story statistics. Primarily, passage and word counts.</p>
<p role="note"><b>Note:</b> Unsupported when watch mode (<kbd>-w</kbd>, <kbd>--watch</kbd>) is enabled.</p>
</dd>
<dt><kbd>-m SRC</kbd>, <kbd>--module=SRC</kbd></dt><dd>Module sources (repeatable); may consist of supported files and/or directories to recursively search for such files. Each file will be wrapped within the appropriate markup and bundled into the &lt;head&gt; element of the compiled HTML. Supported files: <code>.css</code>, <code>.js</code>, <code>.otf</code>, <code>.ttf</code>, <code>.woff</code>, <code>.woff2</code>.</dd>
<dt><kbd>-m SRC</kbd>, <kbd>--module=SRC</kbd></dt><dd>Module sources (repeatable); may consist of supported files and/or directories to recursively search for such files. Each file will be wrapped within the appropriate markup and bundled into the &lt;head&gt; element of the compiled HTML. Supported files: <code>.css</code>, <code>.js</code>, <code>.mjs</code>, <code>.otf</code>, <code>.ttf</code>, <code>.woff</code>, <code>.woff2</code>.</dd>
<dt><kbd>--no-trim</kbd></dt><dd>
<p>Do not trim whitespace surrounding passages—i.e., whitespace preceding and trailing the actual text of the passage. By default, such whitespace is removed when processing passages.</p>
<p role="note"><b>Note:</b> It is recommended that you do not disable passage trimming.</p>
@ -86,7 +86,9 @@ The following extensions are supported:
<dt><code>.tw</code>, <code>.twee</code></dt>
<dd>
<p>Twee notation source files to process for passages.</p>
<p role="note"><b>Note:</b> If any of these files are in the unofficial Twee2 notation, you must manually enable the Twee2 compatibility mode via its command line option (<kbd>--twee2-compat</kbd>).</p>
<p role="note"><b>Note:</b>
If any of these files are in the unofficial Twee2 notation, you must manually enable the Twee2 compatibility mode via its command line option (<kbd>--twee2-compat</kbd>).
</p>
</dd>
<dt><code>.tw2</code>, <code>.twee2</code></dt>
<dd>Unofficial Twee2 notation source files to process for passages. Twee2 compatibility mode is automatically enabled for files with these extensions.</dd>
@ -96,6 +98,13 @@ The following extensions are supported:
<dd>CSS source files to bundle.</dd>
<dt><code>.js</code></dt>
<dd>JavaScript source files to bundle.</dd>
<dt><code>.mjs</code></dt>
<dd>
<p>JavaScript module (ESM) source files to bundle.</p>
<p role="note"><b>Note:</b>
May only be used with the module option (<kbd>-m SRC</kbd>, <kbd>--module=SRC</kbd>).
</p>
</dd>
<dt><code>.otf</code>, <code>.ttf</code>, <code>.woff</code>, <code>.woff2</code></dt>
<dd>Font files to bundle, as <code>@font-face</code> style rules. The generated name of the font family will be the font's base filename sans its extension—e.g., the family name for <code>chinacat.tff</code> will be <code>chinacat</code>.</dd>
<dt><code>.gif</code>, <code>.jpeg</code>, <code>.jpg</code>, <code>.png</code>, <code>.svg</code>, <code>.tif</code>, <code>.tiff</code>, <code>.webp</code></dt>