build based on 2b83c1d

Author: Documenter.jl

previews/PR479/.documenter/.vitepress/config.mts

@@ -0,0 +1,172 @@
+import { defineConfig } from 'vitepress'
+import { tabsMarkdownPlugin } from 'vitepress-plugin-tabs'
+import mathjax3 from "markdown-it-mathjax3";
+import footnote from "markdown-it-footnote";
+import { transformerMetaWordHighlight } from '@shikijs/transformers';
+
+const baseTemp = {
+  base: '/HarmonicBalance.jl/previews/PR479/',// TODO: replace this in makedocs!
+}
+
+const navTemp = {
+  nav: [
+{ text: 'Home', link: '/index' },
+{ text: 'Getting Started', link: '/introduction/index' },
+{ text: 'Theoretical Background', collapsed: false, items: [
+{ text: 'Floquet expansions', link: '/background/harmonic_balance' },
+{ text: 'Stability and Linear Response', link: '/background/stability_response' },
+{ text: 'Limit Cycles', link: '/background/limit_cycles' }]
+ },
+{ text: 'Tutorials', collapsed: false, items: [
+{ text: 'Steady States', link: '/tutorials/steady_states' },
+{ text: 'Classifying Solutions', link: '/tutorials/classification' },
+{ text: 'Linear Response', link: '/tutorials/linear_response' },
+{ text: 'Transient Dynamics', link: '/tutorials/time_dependent' },
+{ text: 'Limit Cycles', link: '/tutorials/limit_cycles' },
+{ text: 'Examples', collapsed: false, items: [
+{ text: 'Wave Mixing', link: '/examples/wave_mixing' },
+{ text: 'Parametric Three Wave Mixing', link: '/examples/parametric_via_three_wave_mixing' },
+{ text: 'Parametric Oscillator', link: '/examples/parametron' },
+{ text: 'State Dependent Perturbation', link: '/examples/state_dependent_perturbation' },
+{ text: 'Ab Initio Noise spectrum', link: '/examples/ab_initio_noise' },
+{ text: 'Adiabatic sweep', link: '/examples/steady_state_sweep' },
+{ text: 'Quantum Cumulants', link: '/examples/cumulants_KPO' },
+{ text: 'KB vs HB method', link: '/examples/harmonic_oscillator_KB_vs_HB' },
+{ text: 'Forward Transmission', link: '/examples/forward_transmission' }]
+ }]
+ },
+{ text: 'Resources', collapsed: false, items: [
+{ text: 'API', link: '/manual/API' },
+{ text: 'Bibliography', link: '/introduction/citation' },
+{ text: 'Manual', collapsed: false, items: [
+{ text: 'Entering Equations of Motion', link: '/manual/entering_eom' },
+{ text: 'Computing Effective System', link: '/manual/extracting_harmonics' },
+{ text: 'Computing Steady States', link: '/manual/methods' },
+{ text: 'Extract the Steady States', link: '/manual/analyse_solutions' },
+{ text: 'Plotting', link: '/manual/plotting' },
+{ text: 'Time Evolution', link: '/manual/time_dependent' },
+{ text: 'Linear Response', link: '/manual/linear_response' },
+{ text: 'SciML Extension', link: '/manual/SciMLExt' }]
+ }]
+ }
+]
+,
+}
+
+const nav = [
+  ...navTemp.nav,
+  {
+    component: 'VersionPicker'
+  }
+]
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  base: baseTemp.base,
+  title: 'HarmonicBalance.jl',
+  description: 'Documentation for HarmonicBalance.jl',
+  cleanUrls: true,
+  outDir: '../1', // This is required for MarkdownVitepress to work correctly...
+  head: [
+    [
+      "script",
+      { async: "", src: "https://www.googletagmanager.com/gtag/js?id=G-RE962QZ6DQ" },
+    ],
+    [
+      "script",
+      {},
+      `window.dataLayer = window.dataLayer || [];
+              function gtag(){dataLayer.push(arguments);}
+              gtag('js', new Date());
+              gtag('config', 'G-RE962QZ6DQ');`,
+    ],
+    ['link', { rel: 'icon', href: '/HarmonicBalance.jl/dev/favicon.ico' }],
+    ['link', { rel: 'icon', href: `${baseTemp.base}favicon.ico` }],
+    ['link', { rel: 'manifest', href: '/site.webmanifest' }],
+
+    ['script', { src: `/HarmonicBalance.jl/versions.js` }],
+    ['script', { src: `${baseTemp.base}siteinfo.js` }]
+  ],
+  ignoreDeadLinks: true,
+
+  markdown: {
+    math: true,
+
+    // options for @mdit-vue/plugin-toc
+    // https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-toc#options
+    toc: { level: [2, 3, 4] }, // for API page, triggered by: [[toc]]
+
+    config(md) {
+      md.use(tabsMarkdownPlugin),
+        md.use(mathjax3),
+        md.use(footnote)
+    },
+    theme: {
+      light: "github-light",
+      dark: "github-dark"
+    }
+  },
+  themeConfig: {
+    outline: 'deep',
+    logo: { src: '/logo.png', width: 24, height: 24},
+    search: {
+      provider: 'local',
+      options: {
+        detailedView: true
+      }
+    },
+    nav,
+    sidebar: [
+{ text: 'Home', link: '/index' },
+{ text: 'Getting Started', link: '/introduction/index' },
+{ text: 'Theoretical Background', collapsed: false, items: [
+{ text: 'Floquet expansions', link: '/background/harmonic_balance' },
+{ text: 'Stability and Linear Response', link: '/background/stability_response' },
+{ text: 'Limit Cycles', link: '/background/limit_cycles' }]
+ },
+{ text: 'Tutorials', collapsed: false, items: [
+{ text: 'Steady States', link: '/tutorials/steady_states' },
+{ text: 'Classifying Solutions', link: '/tutorials/classification' },
+{ text: 'Linear Response', link: '/tutorials/linear_response' },
+{ text: 'Transient Dynamics', link: '/tutorials/time_dependent' },
+{ text: 'Limit Cycles', link: '/tutorials/limit_cycles' },
+{ text: 'Examples', collapsed: false, items: [
+{ text: 'Wave Mixing', link: '/examples/wave_mixing' },
+{ text: 'Parametric Three Wave Mixing', link: '/examples/parametric_via_three_wave_mixing' },
+{ text: 'Parametric Oscillator', link: '/examples/parametron' },
+{ text: 'State Dependent Perturbation', link: '/examples/state_dependent_perturbation' },
+{ text: 'Ab Initio Noise spectrum', link: '/examples/ab_initio_noise' },
+{ text: 'Adiabatic sweep', link: '/examples/steady_state_sweep' },
+{ text: 'Quantum Cumulants', link: '/examples/cumulants_KPO' },
+{ text: 'KB vs HB method', link: '/examples/harmonic_oscillator_KB_vs_HB' },
+{ text: 'Forward Transmission', link: '/examples/forward_transmission' }]
+ }]
+ },
+{ text: 'Resources', collapsed: false, items: [
+{ text: 'API', link: '/manual/API' },
+{ text: 'Bibliography', link: '/introduction/citation' },
+{ text: 'Manual', collapsed: false, items: [
+{ text: 'Entering Equations of Motion', link: '/manual/entering_eom' },
+{ text: 'Computing Effective System', link: '/manual/extracting_harmonics' },
+{ text: 'Computing Steady States', link: '/manual/methods' },
+{ text: 'Extract the Steady States', link: '/manual/analyse_solutions' },
+{ text: 'Plotting', link: '/manual/plotting' },
+{ text: 'Time Evolution', link: '/manual/time_dependent' },
+{ text: 'Linear Response', link: '/manual/linear_response' },
+{ text: 'SciML Extension', link: '/manual/SciMLExt' }]
+ }]
+ }
+]
+,
+    editLink: { pattern: "https://github.com/QuantumEngineeredSystems/HarmonicBalance.jl/edit/master/docs/src/:path" },
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/QuantumEngineeredSystems/HarmonicBalance.jl' },
+      { icon: 'twitter', link: 'https://x.com/Zilberberg_Phys' },
+    ],
+
+    footer: {
+      message: 'Made with <a href="https://documenter.juliadocs.org/" target="_blank"><strong>Documenter.jl</strong></a>, <a href="https://vitepress.dev" target="_blank"><strong>VitePress</strong></a> and <a href="https://luxdl.github.io/DocumenterVitepress.jl/" target="_blank"><strong>DocumenterVitepress.jl</strong>',
+      copyright: `© Copyright ${new Date().getUTCFullYear()}. Released under the MIT License.`
+    },
+  }
+})

previews/PR479/.documenter/.vitepress/mathjax-plugin.ts

@@ -0,0 +1,161 @@
+// adapter from https://github.com/orgs/vuepress-theme-hope/discussions/5178#discussioncomment-15642629
+// mathjax-plugin.ts
+// @ts-ignore
+import MathJax from '@mathjax/src'
+import type { Plugin as VitePlugin } from 'vite'
+import type MarkdownIt from 'markdown-it'
+import { tex as mdTex } from '@mdit/plugin-tex'
+
+const mathjaxStyleModuleID = 'virtual:mathjax-styles.css'
+
+interface MathJaxOptions {
+  font?: string
+}
+
+async function initializeMathJax(options: MathJaxOptions = {}) {
+  const font = options.font || 'mathjax-newcm'
+
+  const config: any = {
+    loader: {
+      load: [
+        'input/tex',
+        'output/svg',
+        '[tex]/boldsymbol',
+        '[tex]/braket',
+        '[tex]/mathtools',
+      ],
+    },
+    tex: {
+      tags: 'ams',
+      packages: {
+        '[+]': ['boldsymbol', 'braket', 'mathtools'],
+      },
+    },
+    output: {
+      font,
+      displayOverflow: 'linebreak',
+      mtextInheritFont: true,
+    },
+    svg: {
+      fontCache: 'none', // critical: avoids async font loading
+    },
+  }
+
+  await MathJax.init(config)
+
+  const fontData = MathJax.config.svg?.fontData
+
+  if (fontData?.dynamicFiles) {
+    const dynamicFiles = fontData.dynamicFiles
+    const dynamicPrefix: string =
+      fontData.OPTIONS?.dynamicPrefix || fontData.options?.dynamicPrefix
+
+    if (dynamicPrefix) {
+      await Promise.all(
+        Object.keys(dynamicFiles).map(async (name) => {
+          try {
+            await import(/* @vite-ignore */ `${dynamicPrefix}/${name}.js`)
+            dynamicFiles[name]?.setup?.(MathJax.startup.output.font)
+          } catch {
+            // Silently ignore missing dynamic files
+          }
+        }),
+      )
+    }
+  }
+}
+
+export function mathjaxPlugin(options: MathJaxOptions = {}) {
+  let adaptor: any
+  let initialized = false
+
+  async function ensureInitialized() {
+    if (!initialized) {
+      await initializeMathJax(options)
+      adaptor = MathJax.startup.adaptor
+      initialized = true
+    }
+  }
+
+  function renderMath(content: string, displayMode: boolean): string {
+    if (!initialized) {
+      throw new Error('MathJax not initialized')
+    }
+
+    const node = MathJax.tex2svg(content, { display: displayMode })
+
+    // Prevent Vue from touching MathJax output
+    adaptor.setAttribute(node, 'v-pre', '')
+
+    let html = adaptor.outerHTML(node)
+
+    // Preserve spaces inside mjx-break (SVG only)
+    html = html.replace(
+      /<mjx-break(.*?)>(.*?)<\/mjx-break>/g,
+      (_: string, attr: string, inner: string) =>
+        `<mjx-break${attr}>${inner.replace(/ /g, '&nbsp;')}</mjx-break>`,
+    )
+    
+    // Wrap only display equations (not inline math)
+    html = html.replace(
+      /(<mjx-container[^>]*display="true"[^>]*>)([\s\S]*?)(<\/mjx-container>)/,
+      '<div class="mjx-scroll-wrapper">$1$2$3</div>'
+    )
+
+    return html
+  }
+
+  function getMathJaxStyles(): string {
+    return initialized
+      ? adaptor.textContent(MathJax.svgStylesheet()) || ''
+      : ''
+  }
+
+  function resetMathJax(): void {
+    if (!initialized) return
+    MathJax.texReset()
+    MathJax.typesetClear()
+  }
+
+  function viteMathJax(): VitePlugin {
+    const virtualModuleID = '\0' + mathjaxStyleModuleID
+
+    return {
+      name: 'mathjax-styles',
+
+      resolveId(id) {
+        if (id === mathjaxStyleModuleID) {
+          return virtualModuleID
+        }
+      },
+
+      async load(id) {
+        if (id === virtualModuleID) {
+          await ensureInitialized()
+          return getMathJaxStyles()
+        }
+      },
+    }
+  }
+
+  function mdMathJax(md: MarkdownIt): void {
+    mdTex(md, {
+      render: renderMath,
+    })
+
+    const orig = md.render
+    md.render = function (...args) {
+      resetMathJax()
+      return orig.apply(this, args)
+    }
+  }
+
+  const init = ensureInitialized()
+
+  return {
+    vitePlugin: viteMathJax(),
+    markdownConfig: mdMathJax,
+    styleModuleID: mathjaxStyleModuleID,
+    init,
+  }
+}