diff --git a/pages/common/highlight.md b/pages/common/highlight.md new file mode 100644 index 000000000..60ae0ee4e --- /dev/null +++ b/pages/common/highlight.md @@ -0,0 +1,24 @@ +# highlight + +> Outputs syntax-highlighted source code to a variety of formats. +> More information: . + +- Produce a complete HTML document from a source code file: + +`highlight --out-format={{html}} --style {{theme_name}} --syntax {{language}} {{path/to/source_code}}` + +- Produce an HTML fragment, suitable for inclusion in a larger document: + +`highlight --out-format={{html}} --fragment --syntax {{language}} {{source_file}}` + +- Inline the CSS styling in every tag: + +`highlight --out-format={{html}} --inline-css --syntax {{language}} {{source_file}}` + +- List all supported languages, themes, or plugins: + +`highlight --list-scripts {{langs|themes|plugins}}` + +- Print a CSS stylesheet for a theme: + +`highlight --out-format={{html}} --print-style --style {{theme_name}} --syntax {{language}}] --stdout`