config-schema.js

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.configSchema = void 0;
exports.configSchema = {
    fileExtension: {
        type: "string",
        default: ".md, .mmark, .markdown",
        description: "You may need restart Atom after making changes here.",
        order: 0,
    },
    configPath: {
        type: "string",
        default: "",
        description: "The configuration directory path. Leave it empty to use '~/.mume' as the config path. Please reload atom to take effect.",
        order: 1,
    },
    singlePreview: {
        title: "Open Only One Preview",
        type: "boolean",
        default: true,
        order: 5,
    },
    previewPanePosition: {
        title: "Position of the preview pane",
        type: "string",
        default: "right",
        enum: ["left", "right", "up", "down", "center"],
        order: 6,
    },
    openPreviewPaneAutomatically: {
        title: "Open preview pane automatically when opening a markdown file",
        type: "boolean",
        default: true,
        order: 10,
    },
    automaticallyShowPreviewOfMarkdownBeingEdited: {
        title: "Automatically show preview of markdown being edited",
        type: "boolean",
        default: true,
        order: 11,
    },
    closePreviewAutomatically: {
        title: "Automatically close preview when closing a markdown file",
        description: "This option only works if `Open Only One Preview` is unchecked.",
        type: "boolean",
        default: true,
        order: 12,
    },
    breakOnSingleNewLine: {
        type: "boolean",
        default: true,
        description: "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.",
        order: 15,
    },
    enableTypographer: {
        type: "boolean",
        default: false,
        description: "Enable smartypants and other sweet transforms.",
        order: 16,
    },
    enableZenMode: {
        title: "Zen Mode",
        type: "boolean",
        default: false,
        description: "Distraction free writing.",
        order: 17,
    },
    codeBlockTheme: {
        description: "Code block theme. If `auto.css` is chosen, then the code block theme that best matches the current preview theme will be picked.",
        default: "auto.css",
        type: "string",
        enum: [
            "auto.css",
            "default.css",
            "atom-dark.css",
            "atom-light.css",
            "atom-material.css",
            "coy.css",
            "darcula.css",
            "dark.css",
            "funky.css",
            "github.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",
            "vs.css",
            "vue.css",
            "xonokai.css",
        ],
        order: 20,
    },
    previewTheme: {
        description: "Preview Theme",
        default: "github-light.css",
        type: "string",
        enum: [
            "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",
        ],
        order: 21,
    },
    revealjsTheme: {
        description: "RevealJS Presentation Theme",
        default: "white.css",
        type: "string",
        enum: [
            "beige.css",
            "black.css",
            "blood.css",
            "league.css",
            "moon.css",
            "night.css",
            "serif.css",
            "simple.css",
            "sky.css",
            "solarized.css",
            "white.css",
            "none.css",
        ],
        order: 22,
    },
    mermaidTheme: {
        description: 'Mermaid theme, you can choose one from ["default", "dark", "forest"]',
        default: "default",
        type: "string",
        enum: ["default", "dark", "forest"],
        order: 23,
    },
    protocolsWhiteList: {
        title: "Protocols Whitelist",
        type: "string",
        default: "http://, https://, atom://, file://, mailto:, tel:",
        description: "Accepted protocols for links.",
        order: 25,
    },
    mathRenderingOption: {
        type: "string",
        default: "KaTeX",
        description: "Choose the Math expression rendering method here. You can also disable math rendering if you want by choosing 'None'.",
        enum: ["KaTeX", "MathJax", "None"],
        order: 30,
    },
    mathInlineDelimiters: {
        title: "Inline Indicator",
        type: "string",
        default: '[["$", "$"], ["\\\\(", "\\\\)"]]',
        description: "Use customized Math expression inline indicator. By default it is '[[\"$\", \"$\"]]', which means content within '**$**' and '**$**' will be rendered in inline mode. You can also define multiple indicators separated by comma. For example, '[[\"$\", \"$\"], [\"\\\\\\\\(\", \"\\\\\\\\)\"]]' will render inline math expression within '**$**' and '**$**', '**\\\\(**' and '**\\\\)**'.",
        order: 31,
    },
    mathBlockDelimiters: {
        title: "Block Indicator",
        type: "string",
        default: '[["$$", "$$"], ["\\\\[", "\\\\]"]]',
        description: 'Use customized Math expression block indicator. By default it is [["$$", "$$"]].',
        order: 32,
    },
    mathRenderingOnlineService: {
        description: "Choose the Math expression rendering method option for GFM markdown export (Save as Markdown).",
        default: "https://latex.codecogs.com/gif.latex",
        type: "string",
        enum: [
            "https://latex.codecogs.com/gif.latex",
            "https://latex.codecogs.com/svg.latex",
            "https://latex.codecogs.com/png.latex",
        ],
        order: 33,
    },
    usePandocParser: {
        title: "Use Pandoc Parser",
        type: "boolean",
        default: false,
        description: "Enable this option will render markdown by pandoc instead of markdown-it. Live update will be disabled automatically if this option is enabled.",
        order: 35,
    },
    pandocPath: {
        title: "Pandoc Options: Path",
        type: "string",
        default: "pandoc",
        description: "Please specify the correct path to your pandoc executable",
        order: 36,
    },
    pandocArguments: {
        title: "Pandoc Options: Commandline Arguments",
        type: "string",
        default: "",
        description: "Comma separated pandoc arguments e.g. `--smart, --filter=/bin/exe`. Please use long argument names.",
        order: 37,
    },
    pandocMarkdownFlavor: {
        type: "string",
        default: "markdown-raw_tex+tex_math_single_backslash",
        title: "Pandoc Options: Markdown Flavor",
        description: "Enter the pandoc markdown flavor you want",
        order: 38,
    },
    latexEngine: {
        type: "string",
        default: "pdflatex",
        title: "LaTeX Engine",
        description: "Default LaTeX engine used for Pandoc export and LaTeX code chunk.",
        order: 39,
    },
    chromePath: {
        title: "Chrome executable path",
        type: "string",
        default: "",
        description: "Chrome executable path, which is used for Puppeteer export. Leaving it empty means path will be found automatically.",
        order: 45,
    },
    imageMagickPath: {
        title: "ImageMagick command line path",
        type: "string",
        default: "",
        description: "ImageMagick command line path should be either `magick` or `convert`. Leaving it empty means the path will be found automatically.",
        order: 46,
    },
    enableWikiLinkSyntax: {
        title: "Enable Wiki Link syntax",
        type: "boolean",
        default: true,
        description: "Enable Wiki Link syntax support. More information can be found at https://help.github.com/articles/adding-links-to-wikis/",
        order: 49,
    },
    enableLinkify: {
        title: "Enable Linkify",
        type: "boolean",
        default: true,
        description: "Enable or disable conversion of URL-like text to links in the markdown preview.",
        order: 50,
    },
    useGitHubStylePipedLink: {
        title: "Use GitHub style piped wiki link",
        type: "boolean",
        default: true,
        description: "If checked, we use GitHub style piped wiki links, i.e. [[linkText|wikiLink]]. Otherwise, we use [[wikiLink|linkText]] as the original Wikipedia style.",
        order: 51,
    },
    wikiLinkFileExtension: {
        title: "Wiki Link file extension",
        type: "string",
        default: ".md",
        description: "By default, [[test]] will direct to file path `test.md`.",
        order: 52,
    },
    enableEmojiSyntax: {
        title: "Enable emoji and font-awesome syntax",
        type: "boolean",
        default: true,
        description: "Enable emoji & font-awesome plugin. This only works for markdown-it parser, but not pandoc parser.",
        order: 53,
    },
    enableExtendedTableSyntax: {
        title: "Enable extended table syntax",
        type: "boolean",
        default: false,
        description: "Enable extended table syntax to support merging table cells.",
        order: 54,
    },
    enableCriticMarkupSyntax: {
        title: "Enable CriticMarkup syntax",
        type: "boolean",
        default: false,
        description: "Enable CriticMarkup syntax. Only works with markdown-it parser. Please check http://criticmarkup.com/users-guide.php for more information.",
        order: 55,
    },
    liveUpdate: {
        type: "boolean",
        default: true,
        description: "Re-render the preview as the contents of the source changes, without requiring the source buffer to be saved. If disabled, the preview is re-rendered only when the buffer is saved to disk. Disable live update will also disable scroll sync.",
        order: 56,
    },
    frontMatterRenderingOption: {
        title: "Front Matter Rendering Option",
        type: "string",
        description: `You can choose how to preview [markdown front matter](http://assemble.io/docs/YAML-front-matter.html), which is a common place to store document metadata.
Front matter is hidden by default, but you can choose between \`table\` (like [on GitHub](https://blog.github.com/2013-09-27-viewing-yaml-metadata-in-your-documents/)) or \`code block\` (to make it look like a source code listing).`,
        default: "none",
        enum: ["none", "table", "code block"],
        order: 60,
    },
    scrollSync: {
        type: "boolean",
        default: true,
        description: "2 way scroll sync. Sync both markdown source and markdown preview when scrolling.",
        order: 65,
    },
    printBackground: {
        title: "Print Background",
        type: "boolean",
        default: false,
        description: "Whether to print background for file export or not. If set to `false`, then `github-light` preview theme will be used. You can also set `print_background` in front-matter for individual files.",
        order: 70,
    },
    imageFolderPath: {
        title: "Image folder path",
        description: "When using Image Helper to copy images, by default images will be copied to root image folder path '/assets'",
        type: "string",
        default: "/assets",
        order: 75,
    },
    imageUploader: {
        title: "Image Uploader",
        description: "You can choose different image uploader to upload image.",
        type: "string",
        default: "imgur",
        enum: ["imgur", "sm.ms", "qiniu"],
        order: 76,
    },
    imageDropAction: {
        title: "Drop image to editor",
        description: "What to do after you drop an image to editor",
        type: "string",
        default: "copy to image folder",
        enum: [
            "insert relative path",
            "copy to image folder",
            "upload",
            "do nothing",
        ],
        order: 77,
    },
    AccessKey: {
        type: "string",
        default: "",
        title: "Qiniu AccessKey",
        order: 78,
    },
    SecretKey: {
        type: "string",
        default: "",
        title: "Qiniu SecretKey",
        description: "",
        order: 79,
    },
    Bucket: {
        type: "string",
        default: "",
        title: "Qiniu Bucket",
        description: "",
        order: 80,
    },
    Domain: {
        type: "string",
        default: "http://",
        title: "Qiniu Domain",
        description: "",
        order: 81,
    },
    enableScriptExecution: {
        title: "Enable Script Execution",
        description: `Enables executing code chunks and importing javascript files.
    
**⚠️ 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.**
`,
        type: "boolean",
        default: false,
        order: 84,
    },
    enableHTML5Embed: {
        title: "Enable HTML5 Embed",
        description: `Enables transform audio video link to to html5 audio video tags.
    
**⚠️ You need to restart your editor to make this take effect.**
`,
        type: "boolean",
        default: false,
        order: 90,
    },
    HTML5EmbedUseImageSyntax: {
        title: "HTML5 Embed Options: Use Image Syntax",
        description: "Enables video/audio embed with ![]() syntax.",
        type: "boolean",
        default: true,
        order: 91,
    },
    HTML5EmbedUseLinkSyntax: {
        title: "HTML5 Embed Options: Use Link Syntax",
        description: "Enables video/audio embed with []() syntax.",
        type: "boolean",
        default: true,
        order: 92,
    },
    HTML5EmbedIsAllowedHttp: {
        title: "HTML5 Embed Options: Allow Http Schema",
        description: "When true embed media with http:// schema in URLs. When false ignore and don't embed them.",
        type: "boolean",
        default: true,
        order: 93,
    },
    HTML5EmbedAudioAttributes: {
        title: "HTML5 Embed Options: Audio Attributes",
        description: "HTML attributes to pass to audio tags",
        type: "string",
        default: 'controls preload="metadata"',
        order: 94,
    },
    HTML5EmbedVideoAttributes: {
        title: "HTML5 Embed Options: Video Attributes",
        description: "HTML attributes to pass to video tags",
        type: "string",
        default: 'controls preload="metadata"',
        order: 95,
    },
    puppeteerWaitForTimeout: {
        title: "Puppeteer waitFor Timeout",
        description: "Puppeteer waits for a certain timeout in milliseconds before the document export.",
        type: "number",
        default: 0,
        order: 100,
    },
    usePuppeteerCore: {
        title: "Use puppeteer-core",
        description: "If set to true, then locally installed puppeteer-core will be required. Otherwise, the puppeteer globally installed by `npm install -g puppeteer` will be required.",
        type: "boolean",
        default: true,
        order: 101,
    },
    puppeteerArgs: {
        title: "Puppetter launch args",
        description: "Args passed to puppeteer.launch({args: $puppeteerArgs})",
        type: "string",
        default: "[]",
        order: 102,
    },
    plantumlServer: {
        title: "PlantUML server",
        description: `Render using PlantUML server instead of binary. Leave it empty to use the builtin plantuml.jar binary (\`java\` is required in system path). 
Eg: "http://localhost:8080/svg/"
    
**⚠️ You need to restart your editor to make this take effect.**`,
        type: "string",
        default: "",
        order: 110,
    },
};
//# sourceMappingURL=config-schema.js.map