Settings Reference

This page documents all Copymarky settings and their options. Settings control how your content is converted to Markdown and what information is included in the output.

Markdown Formatting

These settings control how Markdown is generated from HTML content.

headingStyle

• Type: "atx" | "setext"
• Default: "atx"
• Description: Controls how Markdown headings are formatted.
  • "atx": Uses hash marks (# H1, ## H2, ### H3, etc.). Works with all heading levels.
  • "setext": Uses underline style for H1 and H2 only:
    • H1 with === underneath
    • H2 with --- underneath
    • H3–H6 fall back to ATX style

When to use: Most modern tools and text editors prefer ATX style. Setext is useful for a more classic Markdown appearance but only supports two heading levels.

Related guides: See Using Copymarky for formatting preview.

---

bulletListMarker

• Type: "-" | "*" | "+"
• Default: "-"
• Description: Specifies which character to use for unordered (bulleted) lists.
  • "-": Dash or hyphen (-)
  • "*": Asterisk (*)
  • "+": Plus sign (+)

When to use: All three are valid Markdown and render identically. Choose based on personal or team preference. Dashes are most common.

---

codeBlockStyle

• Type: "fenced" | "indented"
• Default: "fenced"
• Description: Controls how code blocks are formatted.
  • "fenced": Uses triple backticks with optional language identifier:

    ```javascript
    const x = 1;

  • "indented": Indents code lines by 4 spaces (classic Markdown):

        const x = 1;

When to use: Fenced blocks are more readable and allow syntax highlighting. Indented style is supported everywhere but less feature-rich.

---

linkStyle

• Type: "inlined" | "referenced"
• Default: "inlined"
• Description: Controls how links are formatted in the output.
  • "inlined": Puts the URL inline with the text:

    [Visit Example](https://example.com)

  • "referenced": Separates link text from URLs, with references listed at the bottom:

    [Visit Example][1]
    
    [1]: https://example.com

When to use:

• Inlined: Best for readability in rendered Markdown and when URLs are part of the context.
• Referenced: Better for documents with many links, or when you want to keep the text flow clean.

---

Output Options

These settings determine what information is included in the copied Markdown.

imageHandling

• Type: "keep" | "skip"
• Default: "keep"
• Description: Determines whether images are included in the Markdown output.
  • "keep": Includes images as Markdown image syntax: ![alt text](url)
  • "skip": Removes all images from the output

When to use:

• Keep: When you want to preserve visual content references (images must be hosted at public URLs to display in the Markdown).
• Skip: When you only need the text content, or when images would be broken links after copying.

---

includePageTitle

• Type: boolean
• Default: true
• Description: Whether to include the page title at the top of the copied Markdown.
  • true: Adds a top-level heading (# Page Title) based on the page’s <title> tag
  • false: Omits the page title from output

When to use:

• Enabled: When copying entire pages and want a clear heading in the output.
• Disabled: When copying snippets or when the page title is not relevant to your use case.

---

includeSourceUrl

• Type: boolean
• Default: true
• Description: Whether to include the source URL as a reference link at the end of the output.
  • true: Appends Source: [URL](url) or similar attribution
  • false: Omits the source URL

When to use:

• Enabled: When sharing copied content with others or for citation/attribution.
• Disabled: When creating internal documents where the source is already known.

---

Text Replacements

Text replacements allow you to automate pattern-based transformations on your content. Learn more in the Text Replacement Rules reference.

textReplacements

• Type: Object with pre and post properties
  • pre: { enabled: boolean, rules: TextReplacementRule[] }
  • post: { enabled: boolean, rules: TextReplacementRule[] }
• Default:

  {
    "pre": { "enabled": true, "rules": [] },
    "post": { "enabled": true, "rules": [] }
  }

Description:

• pre rules: Applied to the HTML before conversion to Markdown. Useful for cleaning up HTML attributes, ads, or unwanted elements.
• post rules: Applied to the Markdown after conversion. Useful for normalizing Markdown syntax or removing noise from the final output.

When to use: See Text Replacements Guide for practical examples and best practices.

---

Exporting & Importing Settings

Settings can be exported as JSON and imported on another browser or device. The exported file includes all settings and text replacement rules, making it easy to synchronize your configuration.

See: Import & Export Guide for step-by-step instructions.

---

Settings Structure (JSON Example)

Here’s what an exported settings file looks like:

{
  "headingStyle": "atx",
  "bulletListMarker": "-",
  "codeBlockStyle": "fenced",
  "linkStyle": "inlined",
  "imageHandling": "keep",
  "includePageTitle": true,
  "includeSourceUrl": true,
  "textReplacements": {
    "pre": {
      "enabled": true,
      "rules": []
    },
    "post": {
      "enabled": true,
      "rules": []
    }
  }
}