diff --git a/README.md b/README.md index 6206761..f17c09f 100644 --- a/README.md +++ b/README.md @@ -197,90 +197,107 @@ Placeholder ``` Metadata can also be defined in a separate toml file with simple key-value pairs. +The file `Manifest.toml` will always be included by default. Example: ```toml -# bibliography.bib.toml -author = "Snek" -published = "2020" -test-key = ["test value", "test value 2"] - -# those files won't get imported -ignored-imports = ["style.css"] - -# stylesheets that should be included -included-stylesheets = ["style2.css"] +# document metadata +[metadata] +# language setting of the document +language = 'en' -# other metadata files that should be included -included-configs = [] +# author of the document +author = 'author' -# bibliography that should be included -included-bibliography = ["mybib.toml"] -# glossary that sould be included -included-glossary = ["myglossary.toml"] +# features used in the document +[features] # if external sources (images, stylesheets, MathJax) # should be embedded into the document (default: true) -embed-external = true +embed_external = true # If SmartArrows should be used (default: true) -smart-arrows = true - -# Includes a MathJax script tag in the document to render MathML in chromium. -# (default: true) -include-math-jax = true +smart_arrows = true +include_mathjax = true -### Image processing options ### +[imports] +# those files won't get imported +ignored_imports = [] -# Force convert images to the specified format. -# Supported formats are png, jpeg, gif, bmp, (ico needs size <= 256), avif, pnm -# (default: keep original) -image-format = "jpg" +# stylesheets that should be included +included_stylesheets = ['style.css'] -# the max width for the images. -# if an image is larger than that it get's resized. -# (default: none) -image-max-width = 700 +# bibliography that should be included +included_bibliography = ['Bibliography.toml'] -# the max width for the images. -# if an image is larger than that it get's resized. -# (default: none) -image-max-height = 800 +# glossary that sould be included +included_glossaries = ['Glossary.toml'] -### PDF Options - needs the pdf feature enabled ### +# settings related to pdf rendering +[pdf] # If the header and footer of the pdf should be displayed (default: true) -pdf-display-header-footer = true +display_header_footer = true -# PDF header template of each page (default: empty) -pdf-header-template = "