summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/make4ht/README
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/support/make4ht/README')
-rw-r--r--Master/texmf-dist/doc/support/make4ht/README47
1 files changed, 46 insertions, 1 deletions
diff --git a/Master/texmf-dist/doc/support/make4ht/README b/Master/texmf-dist/doc/support/make4ht/README
index 924456189d8..6b9ba2e30cf 100644
--- a/Master/texmf-dist/doc/support/make4ht/README
+++ b/Master/texmf-dist/doc/support/make4ht/README
@@ -111,7 +111,7 @@ the output format name:
Available extensions:
-latexmk
+latexmk_build
: use `Latexmk` for \LaTeX\ compilation.
@@ -135,6 +135,10 @@ mathjaxnode
convert from MathML code to HTML + CSS or SVG. See [the available
settings](#mathjaxsettings).
+staticsite
+
+: build the document in form suitable for static site generators like [Jekyll](https://jekyllrb.com/).
+
# Build files
`make4ht` supports build files. These are `Lua` scripts which can adjust
@@ -366,6 +370,10 @@ mathjaxnode
convert from MathML code to HTML + CSS or SVG. See [the available
settings](#mathjaxsettings).
+staticsite
+
+: create HTML file in format suitable for static site generators such as [Jekyll](https://jekyllrb.com/)
+
svg-height
: some SVG images produced by `dvisvgm` seem to have wrong dimensions. This filter
@@ -733,6 +741,43 @@ sentence\_match
: Lua pattern used to match a sentence. Default value: `"([^%.^%?^!]*)([%.%?!]?)"`.
+### The `staticsite` filter and extension
+
+site\_root
+
+: directory where generated files should be copied.
+
+map
+
+: table where keys are patterns that match filenames, value contains destination directoryfor matched files, relative to the `site_root` (it is possible to use `..` to swich to parent directory).
+
+file\_pattern
+
+: pattern used for filename generation. It is possible to use string templates and format strings for `os.date` function. Default value of `%Y-%m-%d-${input}` creates names in the form of `YYYY-MM-DD-file_name`.
+
+header
+
+: table with variables to be set in the YAML header in HTML files. If the table value is a function, it is executed with current parameters and HTML page DOM object as arguments.
+
+Example:
+
+
+ local outdir = os.getenv "blog_root"
+
+ filter_settings "staticsite" {
+ site_root = outdir,
+ map = {
+ [".css$"] = "../css/"
+ },
+ header = {
+ layout="post",
+ date = function(parameters, dom)
+ return os.date("!%Y-%m-%d %T", parameters.time)
+ end
+ }
+ }
+
+
# Configuration file {#configfile}
It is possible to globally modify the build settings using the configuration