命令行 - 选项

本页面列出了编译器与 REPL 可用的全部选项。

编译器选项

运行 quarkdown c file.qd 会编译给定文件并将输出保存到文件。

如果项目由多个源文件组成，目标文件必须是根文件，即引入了其他文件的那个文件。

-p 或 --preview：启用编译后的内容自动重载。如果Web 服务器尚未运行，则会启动它并在默认浏览器中打开文档。要在浏览器中渲染分页文档，此选项是必需的。
-w 或 --watch：每当源目录中的某个文件发生变更时，重新编译源文件。
-b <browser> 或 --browser <browser>：设置用于启动预览的浏览器。默认为 default。可接受的值：
- default
- none
- xdg（使用 xdg-open）。default 会回退到此值。
- chrome
- chromium
- firefox
- edge（仅限 Windows）
- 任何其他名称，由 BROWSER_<NAME> 环境变量提供支持
- 浏览器可执行文件的完整路径
--server-port <port>：可选，自定义本地Web 服务器的端口。默认为 8089。

组合使用 -p -w 即可实现实时预览。

--pdf：生成一个 PDF 文件。了解更多请参阅PDF 导出页面。
-o <dir> 或 --out <dir>：设置输出文件的目录。默认为 ./quarkdown-output。
--out-name <name>：设置保存在输出目录中的输出资源的名称。默认为通过.docname 设置的文档名称。实际文件名中的特殊字符会被替换为短横线。
-r <renderer> 或 --render <renderer>：设置目标渲染器。默认为 html。可接受的值：
- html
- html-pdf（等价于 -r html --pdf）
- text（纯文本）

--allow <permission> / --deny <permission>：授予或撤销一项权限（可重复）。可接受的值：project-read、global-read、network、native-content、process、all。默认情况下会授予 project-read 和 native-content。

--pipe：将生成的内容输出到 stdout，而不是保存到文件，并抑制其他日志，便于通过管道传递给其他命令。
--clean：在生成新文件之前删除输出目录的内容。破坏性操作。
--strict：若发生错误，强制程序退出。在非严格模式下，错误会以盒子形式显示在文档中。
--nowrap：阻止将渲染输出包裹在完整的文档结构中。若在 HTML 渲染中启用，只会生成 <body> 标签的内部内容。
--pretty：生成美观的输出代码。这便于调试或更易阅读输出代码，但应在生产环境中禁用，因为结果可能在视觉上受到影响。
--timeout <seconds>：设置允许整个执行完成的最长时间（秒）。0 表示禁用超时。默认为 30 秒。
--no-media-storage：关闭媒体存储系统。
--forbid-function-overwriting：当声明函数时使用了已被占用的名称，会引发编译错误，而不是静默覆盖先前的定义。
--subdoc-naming <strategy>：设置子文档的输出命名策略。默认为 file-name。可接受的值：
- file-name：使用子文档的文件名（可读性好，但容易发生冲突）
- collision-proof：在 file-name 后追加哈希以尽量减少名称冲突
- document-name：使用通过 .docname 设置的文档名称，若未设置则回退到 file-name
-Dloglevel=<level>（JVM 属性）：设置日志级别。若设为 warning 或更高，则不会打印输出内容。