UNPKG

command-line-publish

Version:

Convert `command-line-usage` JSON or JavaScript ESM into HTML or SVG files

22 lines (21 loc) 5.25 kB
<!DOCTYPE html> <html> <head> <meta charset="utf-8" /> <link href="data:image/x-icon;," type="image/x-icon" rel="shortcut icon" /> <title>CLI Docs</title> <style> body { @keyframes blink { 50% { opacity: 0; } } font-family: monospace; } </style> </head> <br/><a style="text-decoration:underline;"><a style="font-weight:bold;">command-line-publish<a style="font-weight:normal;text-decoration:none;font-style:normal;"><a style="text-decoration:none;"><br/><br/> &#xa0;Convert `command-line-usage` JSON or JavaScript ESM into HTML or SVG files &#xa0; &#xa0;<br/> &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0;<br/> &#xa0;<a style="font-style:italic;">clp -c="configPath" [--format=svg|html] target<a style="font-style:normal;"> &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0;<br/><br/><a style="text-decoration:underline;"><a style="font-weight:bold;">Options<a style="font-weight:normal;text-decoration:none;font-style:normal;"><a style="text-decoration:none;"><br/><br/> &#xa0;<a style="font-weight:bold;">-t<a style="font-weight:normal;text-decoration:none;font-style:normal;">, <a style="font-weight:bold;">--target<a style="font-weight:normal;text-decoration:none;font-style:normal;"> <a style="text-decoration:underline;">file-path<a style="text-decoration:none;"> &#xa0; &#xa0; &#xa0;The file path target to which to write the result &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; <br/> &#xa0;<a style="font-weight:bold;">-c<a style="font-weight:normal;text-decoration:none;font-style:normal;">, <a style="font-weight:bold;">--config<a style="font-weight:normal;text-decoration:none;font-style:normal;"> <a style="text-decoration:underline;">file-path<a style="text-decoration:none;"> &#xa0; &#xa0; &#xa0;Config file (or directory) to process for opening its Web URL; must &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; <br/> &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0;export/include a `sections` property, and it is recommended to export a &#xa0; &#xa0; &#xa0; <br/> &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0;`definitions` property as well, for easier reusability with `command-line- &#xa0; &#xa0;<br/> &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0;args`. &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0;<br/> &#xa0;<a style="font-weight:bold;">-f<a style="font-weight:normal;text-decoration:none;font-style:normal;">, <a style="font-weight:bold;">--format<a style="font-weight:normal;text-decoration:none;font-style:normal;"> <a style="text-decoration:underline;">"svg"|"html"<a style="text-decoration:none;"> &#xa0; Format of the output; defaults to "svg". &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0;<br/> &#xa0;<a style="font-weight:bold;">--title<a style="font-weight:normal;text-decoration:none;font-style:normal;"> <a style="text-decoration:underline;">title string<a style="text-decoration:none;"> &#xa0; &#xa0; &#xa0; &#xa0;Title tag text; defaults to "CLI Docs". &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; <br/> &#xa0;<a style="font-weight:bold;">-v<a style="font-weight:normal;text-decoration:none;font-style:normal;">, <a style="font-weight:bold;">--version<a style="font-weight:normal;text-decoration:none;font-style:normal;"> &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; <br/> &#xa0;<a style="font-weight:bold;">-h<a style="font-weight:normal;text-decoration:none;font-style:normal;">, <a style="font-weight:bold;">--help<a style="font-weight:normal;text-decoration:none;font-style:normal;"> &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0; &#xa0;<br/></a></a></a></a></a></a></a></a></a></a></a></a></a></a></a></a></a></a></a></a></a></a></a></a></a></a></a></a></a></a></a></a></a></a></a></a></a></a></a></a> </body> </html>