Giter Club home page Giter Club logo

Comments (3)

WeLoTech avatar WeLoTech commented on August 17, 2024

Update:
Changing the .md file name, is also not resolving the issue.The .md displays the updated img the .pdf still the old one.

from marp-cli.

yhatt avatar yhatt commented on August 17, 2024

Whether images used by Markdowns are refreshed depends on the caching rules provided by both the internal browser process and the remote server serving the image.

Currently, Marp CLI cannot modify the caching rules of the internal browser spawned for making PDF. And there is no plan working for that because it may bring performance degrading and remote server overloading if caching could be disabled.

A common solution suggested in many Markdown processors is adding a query parameter to the image URL that doesn't affect the image. This makes the browser recognize the image that is provided from the new URL, and refresh the image without using a cache.

![](https://example.com/image.jpg)

# Add something useless query param to update, just like `?__update=v1`
![](https://example.com/image.jpg?__update=v1)

# Use different query param to update again
![](https://example.com/image.jpg?__update=v2)

You might write a plugin for the engine to automate this assignment.

References

from marp-cli.

yhatt avatar yhatt commented on August 17, 2024

A plugin example to assign unique query for the image URL when rendering Markdown (WARNING: It may bring overload to remote server):

// engine.config.js
const crypto = require('crypto')

const imageUniqParameterPlugin = (markdownIt) => {
  const imageRuleIndex = markdownIt.inline.ruler.__find__('image')
  if (imageRuleIndex === -1) throw new Error('Parser rule not found: image')

  const originalImageRule = {
    ...markdownIt.inline.ruler.__rules__[imageRuleIndex],
  }

  // Replace existing markdown-it image rule to add unique parameter
  markdownIt.inline.ruler.at(
    'image',
    (state) => {
      const originalNormalizeLink = state.md.normalizeLink

      try {
        // Override normalizeLink to add unique parameter while parsing image
        state.md.normalizeLink = (url) => {
          try {
            const urlObj = new URL(url, 'dummy://dummy.dummy/')

            // Add unique parameter to avoid cache
            urlObj.searchParams.set('__marp_v__', crypto.randomUUID())
            let normalizedUrl = urlObj.toString()

            if (normalizedUrl.startsWith('dummy://dummy.dummy/')) {
              // Remove dummy protocol and host
              normalizedUrl = normalizedUrl.slice(20)
            }

            return originalNormalizeLink(normalizedUrl)
          } catch (e) {
            console.warn(e)

            // Fallback to original normalizeLink if URL parsing failed
            return originalNormalizeLink(url)
          }
        }

        return originalImageRule.fn(state)
      } finally {
        // Restore original normalizeLink
        state.md.normalizeLink = originalNormalizeLink
      }
    },
    { alt: originalImageRule.alt }
  )
}

module.exports = {
  engine: ({ marp }) => marp.use(imageUniqParameterPlugin),
}

from marp-cli.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.