Whether to break on single new line.
If set to false, then two spaces at the end of line will be required to break a line.
The path of Chrome or Chromium.
This is used for puppeteer to generate pdf or images.
The code block theme.
Default layout engine for D2 diagrams.
Path to the D2 executable.
Whether to render D2 diagrams in sketch (hand-drawn) style.
Default theme ID for D2 diagrams.
Whether to enable critic markup syntax.
Whether to enable emoji syntax.
Whether to enable extended table syntax.
Whether to enable HTML5 embed.
Note: This is dangerous and should be used with caution.
Whether to enable linkify.
Whether to enable preview zen mode. Enable this option will hide unnecessary UI elements in preview unless your mouse is over it.
Whether to enable script execution.
Note: This is dangerous and should be used with caution.
Whether to enable tag syntax.
When enabled, #tag-name patterns in body text are rendered as
tag elements (<span class="tag">). Supports nested tags like
#parent/child.
Whether to enable typographer.
Whether to enable wiki link syntax.
The front matter rendering option.
Global custom CSS styles.
This will be inserted into HTML <style> tag.
The audio attributes for HTML5 embed.
Whether to allow HTTP protocol for HTML5 embed. *
Whether to use image syntax for HTML5 embed.
Whether to use link syntax for HTML5 embed.
The video attributes for HTML5 embed.
The folder path for storing images.
The path of ImageMagick.
This is used for converting svg to png.
The content to be included in HTML <head> tag.
This is useful for adding custom styles or scripts.
Whether the current environment is VSCode.
The host of jsdelivr CDN.
KaTeX configuration.
The Kroki server used to render diagrams.
The latex engine.
The files of extensions to be included in the notebook
Markdown parser to use for rendering.
'markdown-it' (default) — built-in markdown-it renderer'pandoc' — render via Pandoc (requires Pandoc installed)'markdown_yo' — render via markdown_yo (WASM or native binary)Path to the markdown_yo native binary.
When set, crossnote will invoke this binary (via stdin/stdout) instead of
the bundled WASM module when markdownParser is 'markdown_yo'.
Performance note: the native binary is faster for files under ~300 KB (roughly 6× faster than WASM due to lower per-call overhead). For very large files (>500 KB) the subprocess I/O cost may exceed the WASM render time, so WASM (the default) is preferable in those cases.
Supports $HOME and ~ variable substitution.
The math delimiters for block math.
For example, [["$$", "$$"]] will render $$x$$ as block math.
The math delimiters for inline math.
For example, [["$", "$"]] will render $x$ as inline math.
MathJax configuration.
https://docs.mathjax.org/en/latest/options/index.html
Default: Defined in ${notebookPath}/.crossnote/configs.js or
{
tex: {},
options: {},
loader: {},
The script source for MathJax.
The online math rendering service used for markdown export.
The math rendering option.
Maximum size (in bytes) of a markdown file that crossnote will
load into the in-memory index. Files larger than this are
skipped during refreshNotes — they won't appear in
autocomplete / backlinks / tag panel, and clicking a wikilink to
them still opens the file (they're just not indexed).
Prevents pathological cases where a committed log / data dump
with a .md extension would otherwise pin its full contents in
memory plus a fully-parsed markdown-it token tree.
Set to 0 to disable the cap entirely.
Mermaid configuration.
The mermaid theme.
The arguments for running the pandoc command.
The pandoc markdown flavor.
The path of the pandoc command.
Parser configuration.
The path of the plantuml.jar file.
The plantuml.jar file could be downloaded from https://sourceforge.net/projects/plantuml/
The PlantUML server.
If this is set, then plantumlJarPath will be ignored.
You run start a plantuml server by running:
$ docker run -d -p 8080:8080 plantuml/plantuml-server:jetty
The preview theme.
Whether to print background for file export.
The protocols white list.
The arguments for running puppeteer.
The timeout for puppeteer to wait for the page to be loaded.
Increase the timeout if the exported file is incomplete.
The reveal.js theme.
Whether to use GitHub style piped link.
[[ text | link ]][[ link | text ]]Whether to use a native VS Code-style context menu in the preview.
When enabled, the right-click context menu inherits VS Code's theme colors and font instead of using the preview theme's styling.
Only takes effect when running inside VS Code.
API key for WebSequenceDiagrams. Required for wider diagram sizes.
The WebSequenceDiagrams server URL.
Controls how bare-filename wiki links (e.g. [[Note]]) are
resolved to a file path.
'relative' — resolve relative to the current note's directory'shortest' — search all notes by filename, preferring the
shortest unique path'absolute' — resolve from the notebook rootLinks starting with / always resolve from the notebook root,
regardless of this setting.
The file extension for the link in wikilink if the link does not have an extension.
The case for the file name in wikilink.
If the value is none, then the file name will not be changed.
Otherwise, the file name will be transformed to the specified case.
You can read https://www.npmjs.com/package/case-anything for more details.
Whether to always show backlinks in preview.