remark42/docs/spa.md

How to configure remark42 for Single Page Apps (SPA)

Originally tested on Nuxt.js, but it should be applicable to all SPAs.

• Add the following JavaScript to your index.html, which in this case, it is identical to <script defer src="$HOST/web/embed.js"></script>

;(function () {
  var host = // Your remark42 host
  var components = ['embed'] // Your choice of remark42 components

  ;(function(c) {
    for (let i = 0; i < c.length; i++) {
      const d = document
      const s = d.createElement('script')
      s.src = remark_config.host + '/web/' + c[i] + '.js'
      s.defer = true
      ;(d.head || d.body).appendChild(s)
    }
  })(components)
})

• Created remark42Instance when the div containing remark42 has appear, usually at mounted or componentDidMount of the SPA lifecycle. Destroy the previous instance first, if neccessary.

  initRemark42() {
    if (window.REMARK42) {
      if (this.remark42Instance) {
        this.remark42Instance.destroy()
      }

      this.remark42Instance = window.REMARK42.createInstance({
        node: this.$refs.remark42 as HTMLElement,
        ...remark42_config  // See <https://github.com/patarapolw/remark42#setup-on-your-website>
      })
    }
  }

  mounted() {
    if (window.REMARK42) {
      this.initRemark42()
    } else {
      window.addEventListener('REMARK42::ready', () => {
        this.initRemark42()
      })
    }
  }

• Ensure that this is called every time route changes

  @Watch('$route.path')
  onRouteChange() {
    this.initRemark42()
  }

• And, destroyed before routeLeave

  beforeRouteLeave() {
    if (this.remark42Instance) {
      this.remark42Instance.destroy()
    }
  }