MarkDownload Documentation

repository·main·Indexed 26 days ago

https://github.com/deathau/markdownload

A web clipper extension for Google Chrome, Firefox, Microsoft Edge, and Safari that converts web pages into readable Markdown files. It supports clipping entire pages or selected text, custom front/back templates for YAML frontmatter, and integration with Obsidian via the Advanced Obsidian URI plugin. Users can customize Markdown formatting styles, configure image downloads, and use custom text substitutions for titles and filenames.

Tokens
1.7K
Snippets
1
Records
11
Agent score
38%

What's inside MarkDownload

  1. Use MarkDownload to clip websites

    main

    To save a webpage as a Markdown file:

    1. Navigate to the page you want to save.
    2. Click the MarkDownload extension icon in your browser bar.
    3. A popup will appear showing the rendered Markdown. You can make minor edits or copy the text directly.
    4. Click the download button to save the content as an .md file.

    Tip: If you select specific text on a page before clicking the extension icon, MarkDownload will download only that selected text.

  2. Clip Selected Text

    main

    To capture specific snippets instead of the whole page:

    1. Select text on the webpage.
    2. Click the MarkDownload icon.
    3. Choose to clip either just the selected text or the entire document.

    Alternatively, if you have already opened the MarkDownload popup, you can select text within the popup and click the Download Selected button that appears.

  3. Use MarkDownload for Basic Clipping

    main
    To clip a website, click the MarkDownload icon in your browser's extension area. A popup will appear showing the website content as Markdown. You can edit the title or content within the popup before clicking the Download button. The filename will be determined by the text in the title box.
  4. Install MarkDownload

    main

    MarkDownload is available for multiple web browsers. You can install it via the respective extension stores:

    • Google Chrome: Available on the Chrome Web Store.
    • Firefox: Available on Firefox Add-ons.
    • Microsoft Edge: Available on Microsoft Edge Add-ons.
    • Safari: Available on the Apple App Store.
  5. Use Context Menu Actions

    main

    Right-click on a page or specific elements to access MarkDownload options without opening the popup:

    • Download Tab as Markdown: Downloads the current tab (Default shortcut: Alt+Shift+M).
    • Download Selection as Markdown: Downloads only the currently highlighted text.
    • Download All Tabs as Markdown: Downloads all open tabs in the current window.
    • Copy Tab as Markdown: Copies the current tab's content to your clipboard.
    • Copy Selection as Markdown: Copies the highlighted text to your clipboard.
    • Copy Tab URL as Markdown Link: Copies the URL and title as a Markdown link.
    • Copy Selected Tabs as Markdown Link: Copies all selected tabs as Markdown links.
    • Copy Link as Markdown: (Right-click a link) Copies the link as a Markdown link.
    • Copy Image as Markdown: (Right-click an image) Copies the image as a Markdown image embed.
    • Include Front/Back Template: Toggles whether your custom templates are applied to the clip via the context menu.
  6. Integrate MarkDownload with Obsidian

    main

    You can send clipped content directly to Obsidian using the "Advanced Obsidian URI" community plugin. This bypasses URL character limits by using the clipboard as the source for new files.

    Prerequisites

    Install and enable the Advanced Obsidian URI plugin in your Obsidian vault.

    Configuration Steps

    1. Left-click the MarkDownload extension icon.
    2. Click the gear icon to open the configuration menu.
    3. Scroll to the Obsidian integration section and toggle enable obsidian integration to ON.
    4. Enter your Obsidian vault name and Obsidian folder name in the provided form.

    Usage

    1. Right-click the MarkDownload extension icon.
    2. Select Send Tab to Obsidian from the menu.
  7. Configure Markdown Formatting Styles

    main

    You can customize the syntax used for various Markdown elements in the extension options:

    • Heading Style: Choose between Setext Style (underlined) or Atx-Style (#).
    • Horizontal Rule Style: Choose between ***, ---, or ___.
    • Bullet List Marker: Choose between *, -, or +.
    • Code Block Style: Choose between Indented or Fenced.
    • Code Block Fence: If using Fenced style, choose between ``` or ~~~.
    • Emphasis (italics) Delimiter: Choose between _ or *.
    • Strong (bold) Delimiter: Choose between ** or __.
    • Link Style: Choose between Inlined, Referenced, or Strip links.
    • Link Reference Style: (If using Referenced) Choose between Full, Collapsed, or Shortcut.
    • Image Style: Choose between Original Source, Strip Images, Pure Markdown, or Obsidian internal embed (with or without folder prefix).
  8. Configure Download Mode and Image Settings

    main

    Note: The following settings are not supported in Safari.

    • Download Mode:
      • Downloads API (Recommended): Allows for subfolders and image downloading.
      • Content Link: A fallback mode if the Downloads API conflicts with other extensions. This mode is more limited and disables subfolders and image downloading.
    • Subfolder: Specifies a subfolder within your downloads folder (only available in Downloads API mode). Uses Custom Text Substitutions.
    • Download Images: If enabled (requires Downloads API), images are downloaded alongside the Markdown file.
    • Image Filename Prefix: Sets a prefix or subfolder for downloaded images. Using a / specifies a subfolder. Default is {title}/.
    • Show Save As Dialog: Forces the browser's 'Save As' popup (only available in Downloads API mode).
  9. Configure Front/Back Templates

    main

    Front and Back templates allow you to prepend or append metadata and text to your Markdown files. These are highly useful for creating YAML frontmatter for tools like Obsidian.

    Default Front Template:

    ---
    created: {date:YYYY-MM-DDTHH:mm:ss} (UTC {date:Z})
    tags: [{keywords}]
    source: {baseURI}
    author: {byline}
    ---
    
    # {pageTitle}
    
    > ## Excerpt
    > {excerpt}
    
    ---

    Templates support Custom Text Substitutions.

  10. Use Custom Text Substitutions

    main

    You can use placeholders in the Title Template, Subfolder, Front/Back Templates, and Image Filename Prefix settings. Supported substitutions include:

    • {title}: Article Title
    • {pageTitle}: Title of the actual page
    • {length}: Length of the article in characters
    • {excerpt}: Article description or short excerpt
    • {byline}: Author metadata
    • {dir}: Content direction
    • {baseURI}: The URL of the article
    • {date:FORMAT}: Current date/time (uses Moment.js format)
    • {keywords}: Meta keywords (comma separated)
    • {keywords:SEPARATOR}: Meta keywords separated by a specific character (e.g., {keywords: } for spaces)
    • Meta Tags: Any supported meta tag (e.g., {og:image}).
  11. Review MarkDownload permissions

    main

    The extension requires the following permissions to function:

    • Data on all sites: Enables the "Download All Tabs" feature (no other data is captured or sent online).
    • Access tabs: Allows access to website content when the icon is clicked.
    • Manage Downloads: Required to download the generated .md files.
    • Storage: Used to persist extension configuration and options.
    • Clipboard: Used to copy Markdown text to your clipboard.