npm - crossnote - Versions diffs - 0.9.32 → 0.9.34 - Mend

crossnote 0.9.32 → 0.9.34

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (26) hide show

package/README.md +5 -242
package/out/cjs/index.cjs +246 -243
package/out/esm/index.mjs +248 -245
package/out/styles/prism_theme/github-dark.css +1 -1
package/out/styles/prism_theme/vscode.css +1 -1
package/out/styles/prism_theme/vue.css +1 -1
package/out/styles/style-template.css +1 -1
package/out/types/src/lib/lru-cache.d.ts +7 -0
package/out/types/src/markdown-engine/index.d.ts +2 -0
package/out/types/src/markdown-engine/inline-offline-assets.d.ts +2 -0
package/out/types/src/notebook/index.d.ts +5 -0
package/out/types/src/notebook/types.d.ts +3 -1
package/out/types/src/tools/image-uploader.d.ts +1 -0
package/out/types/src/webview/components/MarkdownEditor.d.ts +2 -0
package/out/types/test/front-matter-table.test.d.ts +1 -0
package/out/types/test/html-export-offline-embed.test.d.ts +1 -0
package/out/types/test/image-uploader-url.test.d.ts +1 -0
package/out/types/test/inline-offline-assets.test.d.ts +1 -0
package/out/types/test/notebook-delete-note.test.d.ts +1 -0
package/out/types/test/notebook-walk-containment.test.d.ts +1 -0
package/out/types/tsconfig.tsbuildinfo +1 -1
package/out/webview/backlinks.css +1 -1
package/out/webview/graph-view.css +1 -1
package/out/webview/preview.css +1 -1
package/out/webview/preview.js +494 -819
package/package.json +4 -4

package/README.md CHANGED Viewed

@@ -81,248 +81,11 @@ main();
 ## Notebook Configuration
-[Visit here to see the documentation.](https://shd101wyy.github.io/crossnote/interfaces/NotebookConfig.html)
-```js
-const config = {
-  // File of extensions to be included in the notebook
-  markdownFileExtensions: [".md", ".markdown", ".mdown", ".mkdn", ".mkd", ".rmd", ".qmd", ".mdx"],
-  // The content to be included in HTML `<head>` tag.
-  // This is useful for adding custom styles or scripts.
-  includeInHeader: "",
-  // Markdown parser to use for rendering.
-  // Options: 'markdown-it' (default), 'pandoc', 'markdown_yo'
-  // - 'markdown-it': built-in markdown-it renderer
-  // - 'pandoc': render via Pandoc (requires Pandoc installed)
-  // - 'markdown_yo': high-performance renderer (see below); markdown-it is
-  //   still used for token-based operations (backlink extraction, etc.)
-  markdownParser: 'markdown-it',
-  // Path to the markdown_yo native binary.
-  // When set and markdownParser is 'markdown_yo', crossnote invokes this binary
-  // (via stdin/stdout) instead of the bundled WASM module.
-  // See the "markdown_yo" section below for performance guidance.
-  // Supports $HOME and ~ variable substitution. Default: '' (use WASM).
-  markdownYoBinaryPath: '',
-  // In Markdown, a single newline character doesn't cause a line break in the generated HTML. In GitHub Flavored Markdown, that is not true. Enable this config option to insert line breaks in rendered HTML for single newlines in Markdown source.
-  breakOnSingleNewLine: true,
-  // Whether to enable preview zen mode.
-  // Enable this option will hide unnecessary UI elements in preview unless your mouse is over it.
-  enablePreviewZenMode: boolean;
-  // Enable smartypants and other sweet transforms.
-  enableTypographer: false,
-  // Enable conversion of URL-like text to links in the markdown preview.
-  enableLinkify: true,
-  // Math
-  mathRenderingOption: "KaTeX",  // "KaTeX" | "MathJax" | "None"
-  mathInlineDelimiters: [["$", "$"], ["\\(", "\\)"]],
-  mathBlockDelimiters: [["$$", "$$"], ["\\[", "\\]"]],
-  mathRenderingOnLineService: "https://latex.codecogs.com/gif.latex", // "https://latex.codecogs.com/svg.latex", "https://latex.codecogs.com/png.latex"
-  mathjaxScriptSrc: 'https://cdn.jsdelivr.net/npm/mathjax@4/tex-mml-chtml.js',
-  // Enable Wiki Link syntax support. More information can be found a  https://help.github.com/articles/adding-links-to-wikis/
-  enableWikiLinkSyntax: true,
-  // If checked, we use GitHub style piped wiki links, i.e. [[linkText|wikiLink]]. Otherwise, we use
-  // [[wikiLink|linkText]] as the original Wikipedia style.
-  useGitHubStylePipedLink: true
-  // Enable emoji & font-awesome plugin. This only works for markdown-it parser, but not pandoc parser.
-  enableEmojiSyntax: true
-  // Enable extended table syntax to support merging table cells.
-  enableExtendedTableSyntax: false
-  // Enable CriticMarkup syntax. Only works with markdown-it parser.
-  // Please check http://criticmarkup.com/users-guide.php for more information.
-  enableCriticMarkupSyntax: false
-  // Enable Obsidian-style #tag syntax in body text.
-  // Renders `#tag-name` (and nested `#parent/child`) as clickable
-  // pill-shaped anchors that emit a `clickTag` postMessage when clicked,
-  // so the host extension can route to a tag-specific search/backlinks
-  // panel.  Tags inside code spans, fenced code blocks, URL fragments,
-  // and `{...}` block-attribute spans are skipped.
-  enableTagSyntax: true,
-  // When true, the right-click context menu in the preview inherits the
-  // VS Code theme (colours, font, border) instead of using the default
-  // Contexify dark/light theme.  Only takes effect when running inside
-  // a VS Code webview (the rule is gated on body.vscode-* classes).
-  useVSCodeThemeForContextMenu: false,
-  // Front matter rendering option
-  frontMatterRenderingOption: 'none', // 'none' | 'table' | 'code block'
-  // Mermaid theme
-  mermaidTheme: 'default', // 'default' | 'dark' | 'forest'
-  // Code Block theme
-  // If `auto.css` is chosen, then the code block theme that best matches the current preview theme will be picked.
-  codeBlockTheme: 'auto.css',
-  //  "auto.css",
-  //  "default.css",
-  //  "atom-dark.css",
-  //  "atom-light.css",
-  //  "atom-material.css",
-  //  "coy.css",
-  //  "darcula.css",
-  //  "dark.css",
-  //  "funky.css",
-  //  "github.css",
-  //  "github-dark.css"
-  //  "hopscotch.css",
-  //  "monokai.css",
-  //  "okaidia.css",
-  //  "one-dark.css",
-  //  "one-light.css",
-  //  "pen-paper-coffee.css",
-  //  "pojoaque.css",
-  //  "solarized-dark.css",
-  //  "solarized-light.css",
-  //  "twilight.css",
-  //  "vue.css",
-  //  "vs.css",
-  //  "xonokai.css"
-  // Preview theme
-  previewTheme: 'github-light.css',
-  // "atom-dark.css",
-  // "atom-light.css",
-  // "atom-material.css",
-  // "github-dark.css",
-  // "github-light.css",
-  // "gothic.css",
-  // "medium.css",
-  // "monokai.css",
-  // "newsprint.css",
-  // "night.css",
-  // "none.css",
-  // "one-dark.css",
-  // "one-light.css",
-  // "solarized-dark.css",
-  // "solarized-light.css",
-  // "vue.css"
-  // Revealjs presentation theme
-  revealjsTheme: "white.css",
-  // "beige.css",
-  // "black.css",
-  // "blood.css",
-  // "league.css",
-  // "moon.css",
-  // "night.css",
-  // "serif.css",
-  // "simple.css",
-  // "sky.css",
-  // "solarized.css",
-  // "white.css",
-  // "none.css"
-  // Accepted protocols for links.
-  protocolsWhiteList: "http://, https://, atom://, file://, mailto:, tel:",
-  // When using Image Helper to copy images, by default images will be copied to root image folder path '/assets'
-  imageFolderPath: '/assets',
-  // Whether to print background for file export or not. If set to `false`, then `github-light` preview theme will b  used. You can also set `print_background` in front-matter for individual files.
-  printBackground: false,
-  // Chrome executable path, which is used for Puppeteer export. Leaving it empty means the path will be found automatically.
-  chromePath: '',
-  // ImageMagick command line path. Should be either `magick` or `convert`.
-  // Leaving it empty we will use `sharp` instead.
-  imageMagickPath: '',
-  // Pandoc executable path
-  pandocPath: 'pandoc',
-  // Pandoc markdown flavor
-  pandocMarkdownFlavor: "markdown-raw_tex+tex_math_single_backslash",
-  // Pandoc arguments e.g. ['--smart', '--filter=/bin/exe']. Please use long argument names.
-  pandocArguments: [],
-  // Default latex engine for Pandoc export and latex code chunk.
-  latexEngine: 'pdflatex',
-  // Enables executing code chunks and importing javascript files.
-  // This enables also the sidebar table of content.
-  // ⚠ ️ Please use this feature with caution because it may put your security at risk!
-  //    Your machine can get hacked if someone makes you open a markdown with malicious code while script execution is enabled.
-  enableScriptExecution: false,
-  // Enables transform audio video link to to html5 embed audio video tags.
-  // Internally it enables markdown-it-html5-embed plugins.
-  enableHTML5Embed: false,
-  // Enables video/audio embed with ![]() syntax (default).
-  HTML5EmbedUseImageSyntax: true,
-  // Enables video/audio embed with []() syntax.
-  HTML5EmbedUseLinkSyntax: false,
-  // When true embed media with http:// schema in URLs. When false ignore and don't embed them.
-  HTML5EmbedIsAllowedHttp: false,
-  // HTML attributes to pass to audio tags.
-  HTML5EmbedAudioAttributes: 'controls preload="metadata" width="320"',
-  // HTML attributes to pass to video tags.
-  HTML5EmbedVideoAttributes: 'controls preload="metadata" width="320" height="240"',
-  // Puppeteer waits for a certain timeout in milliseconds before the document export.
-  puppeteerWaitForTimeout: 0,
-  // Args passed to puppeteer.launch({args: $puppeteerArgs})
-  puppeteerArgs: [],
-  // Render using PlantUML server instead of binary. Leave it empty to use the plantuml.jar file at `plantumlJarPath` (`java` is required in system path). Eg: "http://localhost:8080/svg/".
-  // You run start a plantuml server by running:
-  // $ docker run -d -p 8080:8080 plantuml/plantuml-server:jetty
-  plantumlServer: "http://localhost:8080/svg/",
-  // The absolute of the PlantUML jar file.
-  // The plantuml.jar file could be downloaded from https://sourceforge.net/projects/plantuml/
-  plantumlJarPath: "",
-  // Example values:
-  // - cdn.jsdelivr.net
-  // - fastly.jsdelivr.net
-  // - gcore.jsdelivr.net
-  // - testingcf.jsdelivr.net
-  jsdelivrCdnHost: "cdn.jsdelivr.net",
-  // Kroki server url.
-  krokiServer: "https://kroki.io",
-  // The WebSequenceDiagrams server URL.
-  webSequenceDiagramsServer: "https://www.websequencediagrams.com";
-  // API key for WebSequenceDiagrams. Required for wider diagram sizes.
-  webSequenceDiagramsApiKey: "";
-  // Always show backlinks in the preview.
-  alwaysShowBacklinksInPreview: false,
-  // Maximum size (in bytes) of a markdown file that crossnote will
-  // load into the in-memory note index.  Files larger than this are
-  // skipped during `refreshNotes` so a checked-in 50 MB log / data
-  // dump with a `.md` extension can't pin its full content (plus a
-  // markdown-it token tree several × that size) in memory.  Files
-  // above the cap are still openable by wikilink click — they're
-  // just not indexed for autocomplete, backlinks, or the tag panel.
-  // Set to 0 to disable the cap entirely.
-  maxNoteFileSize: 5_242_880, // 5 MiB
-}
-```
+All notebook configuration options — types, defaults, and per-field documentation — live in the API reference:
+👉 [NotebookConfig](https://shd101wyy.github.io/crossnote/interfaces/NotebookConfig.html)
+The snippet in the [Example](#example) section above shows the commonly used options (`previewTheme`, `codeBlockTheme`, `mathRenderingOption`, `printBackground`, `enableScriptExecution`, `chromePath`, ...).
 ## Notebook Local Configuration