docusaurus-plugin-glossary 1.1.2 → 1.3.1

package/index.js

@@ -1,158 +0,0 @@
-const path = require('path');
-const fs = require('fs-extra');
-
-/**
- * Docusaurus Glossary Plugin
- *
- * A plugin that provides glossary functionality with:
- * - Glossary terms defined in a JSON file
- * - Auto-generated glossary page
- * - GlossaryTerm component for inline definitions
- * - Tooltips on hover
- * - Automatic glossary term detection in markdown files
- *
- * @param {object} context - Docusaurus context
- * @param {object} options - Plugin options
- * @param {string} options.glossaryPath - Path to glossary JSON file (default: 'glossary/glossary.json')
- * @param {string} options.routePath - Route path for glossary page (default: '/glossary')
- * @param {boolean} options.autoLinkTerms - Automatically link glossary terms in markdown (default: true)
- * @returns {object} Plugin object
- */
-function glossaryPlugin(context, options = {}) {
-  const { 
-    glossaryPath = 'glossary/glossary.json', 
-    routePath = '/glossary',
-    autoLinkTerms = true
-  } = options;
-
-  let glossaryDataCache = { terms: [] };
-
-  return {
-    name: 'docusaurus-plugin-glossary',
-
-    configureMarkdown(markdownConfig) {
-      // Automatically configure the remark plugin if autoLinkTerms is enabled
-      if (autoLinkTerms) {
-        if (!markdownConfig.remarkPlugins) {
-          markdownConfig.remarkPlugins = [];
-        }
-
-        const remarkPlugin = require('./remark/glossary-terms');
-
-        // Check if the remark plugin is already configured
-        const isAlreadyConfigured = markdownConfig.remarkPlugins.some(
-          (plugin) => {
-            if (Array.isArray(plugin) && plugin[0]) {
-              // Check if it's our remark plugin by comparing the function reference
-              return plugin[0] === remarkPlugin;
-            }
-            // Also check if it's directly the remark plugin function
-            return plugin === remarkPlugin;
-          }
-        );
-
-        // Only add if not already configured
-        if (!isAlreadyConfigured) {
-          markdownConfig.remarkPlugins.push([
-            remarkPlugin,
-            {
-              glossaryPath,
-              routePath,
-              siteDir: context.siteDir,
-            }
-          ]);
-        }
-      }
-    },
-
-    async loadContent() {
-      // Load glossary terms from JSON file
-      const glossaryFilePath = path.resolve(context.siteDir, glossaryPath);
-
-      if (await fs.pathExists(glossaryFilePath)) {
-        const glossaryData = await fs.readJson(glossaryFilePath);
-        glossaryDataCache = glossaryData;
-        return glossaryData;
-      }
-
-      console.warn(`Glossary file not found at ${glossaryFilePath}. Using empty glossary.`);
-      glossaryDataCache = { terms: [] };
-      return { terms: [] };
-    },
-
-    async contentLoaded({ content, actions }) {
-      const { createData, addRoute, setGlobalData } = actions;
-
-      // Create data file that can be imported by components
-      const glossaryDataPath = await createData('glossary-data.json', JSON.stringify(content));
-      
-      // Create a data file for the remark plugin to access glossary terms
-      const remarkGlossaryDataPath = await createData(
-        'remark-glossary-data.json',
-        JSON.stringify({
-          terms: content.terms || [],
-          routePath: routePath,
-        })
-      );
-
-      // Add glossary page route
-      addRoute({
-        path: routePath,
-        component: path.join(__dirname, 'components/GlossaryPage.js'),
-        exact: true,
-        modules: {
-          glossaryData: glossaryDataPath,
-        },
-      });
-
-      // Expose global data for runtime lookups (used by GlossaryTerm)
-      setGlobalData({
-        terms: content.terms || [],
-        routePath,
-      });
-    },
-
-    getThemePath() {
-      return path.resolve(__dirname, './theme');
-    },
-
-    getPathsToWatch() {
-      return [path.resolve(context.siteDir, glossaryPath)];
-    },
-
-    async postBuild({ outDir }) {
-      // You can add any post-build steps here if needed
-      console.log('Glossary plugin: Build completed');
-    },
-  };
-}
-
-// Export remark plugin factory for use in markdown configuration
-glossaryPlugin.remarkPlugin = require('./remark/glossary-terms');
-
-/**
- * Helper function to get the configured remark plugin
- * This can be used in docusaurus.config.js markdown configuration
- * 
- * @param {object} pluginOptions - Plugin options from docusaurus.config.js
- * @param {object} context - Docusaurus context
- * @returns {function} Configured remark plugin
- */
-glossaryPlugin.getRemarkPlugin = function(pluginOptions, context) {
-  const { 
-    glossaryPath = 'glossary/glossary.json', 
-    routePath = '/glossary',
-    siteDir = context.siteDir
-  } = pluginOptions;
-
-  return [
-    require('./remark/glossary-terms'),
-    {
-      glossaryPath,
-      routePath,
-      siteDir,
-    }
-  ];
-};
-
-module.exports = glossaryPlugin;

package/theme/GlossaryTerm/index.js

@@ -1,69 +0,0 @@
-import React, { useMemo, useState } from 'react';
-import {usePluginData} from '@docusaurus/useGlobalData';
-import styles from './styles.module.css';
-
-/**
- * GlossaryTerm component - displays an inline term with tooltip
- *
- * Usage:
- * import GlossaryTerm from '@theme/GlossaryTerm';
- *
- * <GlossaryTerm term="API" definition="Application Programming Interface" />
- * or
- * <GlossaryTerm term="API">custom display text</GlossaryTerm>
- *
- * @param {object} props
- * @param {string} props.term - The glossary term
- * @param {string} props.definition - The definition to show in tooltip
- * @param {string} props.routePath - Route path to glossary page (default: '/glossary')
- * @param {React.ReactNode} props.children - Optional custom display text
- */
-export default function GlossaryTerm({ term, definition, routePath = '/glossary', children }) {
-  const [showTooltip, setShowTooltip] = useState(false);
-
-  // Pull definition/route from plugin global data if not provided
-  const pluginData = usePluginData('docusaurus-plugin-glossary');
-  const effectiveDefinition = useMemo(() => {
-    if (definition && typeof definition === 'string' && definition.length > 0) {
-      return definition;
-    }
-    const terms = (pluginData && pluginData.terms) || [];
-    const found = terms.find(
-      (t) => typeof t.term === 'string' && t.term.toLowerCase() === String(term).toLowerCase()
-    );
-    return found && found.definition ? found.definition : undefined;
-  }, [definition, pluginData, term]);
-
-  const effectiveRoutePath = useMemo(() => {
-    if (routePath && typeof routePath === 'string' && routePath.length > 0) return routePath;
-    return (pluginData && pluginData.routePath) || '/glossary';
-  }, [pluginData, routePath]);
-
-  const displayText = children || term;
-  const termId = term.toLowerCase().replace(/\s+/g, '-');
-
-  return (
-    <span className={styles.glossaryTermWrapper}>
-      <a
-        href={`${effectiveRoutePath}#${termId}`}
-        className={styles.glossaryTerm}
-        onMouseEnter={() => setShowTooltip(true)}
-        onMouseLeave={() => setShowTooltip(false)}
-        onFocus={() => setShowTooltip(true)}
-        onBlur={() => setShowTooltip(false)}
-        aria-describedby={`tooltip-${termId}`}
-      >
-        {displayText}
-      </a>
-      {effectiveDefinition && (
-        <span
-          id={`tooltip-${termId}`}
-          className={`${styles.tooltip} ${showTooltip ? styles.tooltipVisible : ''}`}
-          role="tooltip"
-        >
-          <strong>{term}:</strong> {effectiveDefinition}
-        </span>
-      )}
-    </span>
-  );
-}