Eliminate manual file copying requirement - v2.0.0

Refactored plugin to use Docusaurus native plugin APIs, removing the need for users to manually copy theme files. Users now only need to add the plugin to their config - components are automatically bundled and loaded.

Changes:
- Added getThemePath() to provide theme components from plugin
- Restructured directories: src/theme → theme, src/components → components
- Updated component imports to use relative paths
- Version bump to 2.0.0 (breaking change)
- Added .gitignore for node_modules and dev files
- Updated README with zero-config installation and v1.x migration guide

Tested in production: 58 markdown files processed, dropdown working, .md URLs accessible.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

Author: FlyNumber

.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+node_modules/
+
+# Lock files (users should generate their own)
+package-lock.json
+yarn.lock
+
+# Build outputs
+*.log
+npm-debug.log*
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo

README.md

@@ -47,27 +47,9 @@ module.exports = {
 };
 ```
 
-### 2. Copy Theme Files
+**That's it!** The plugin automatically provides all necessary components. No manual file copying required.
 
-Copy the theme files from this package to your project:
-
-**Option A: Manual Copy**
-```bash
-# Copy Root.js theme override
-cp node_modules/docusaurus-markdown-source-plugin/src/theme/Root.js src/theme/Root.js
-
-# Copy MarkdownActionsDropdown component
-mkdir -p src/components/MarkdownActionsDropdown
-cp node_modules/docusaurus-markdown-source-plugin/src/components/MarkdownActionsDropdown/index.js src/components/MarkdownActionsDropdown/index.js
-```
-
-**Option B: Create Symlinks** (advanced users)
-```bash
-ln -s ../../node_modules/docusaurus-markdown-source-plugin/src/theme src/theme
-ln -s ../../node_modules/docusaurus-markdown-source-plugin/src/components/MarkdownActionsDropdown src/components/MarkdownActionsDropdown
-```
-
-### 3. Add Dropdown Styles
+### 2. Add Dropdown Styles (Optional)
 
 Add these styles to your `src/css/custom.css`:
 
@@ -155,7 +137,7 @@ article .markdown header h1 {
 }
 ```
 
-### 4. Build and Test
+### 3. Build and Test
 
 ```bash
 npm run build
@@ -164,6 +146,39 @@ npm run serve
 
 Visit any docs page - you should see the "Open Markdown" dropdown in the header!
 
+## Migration from v1.x
+
+If you're upgrading from v1.x where you manually copied theme files:
+
+### 1. Remove Manually Copied Files
+
+```bash
+# Remove the manually copied theme file
+rm -rf src/theme/Root.js
+
+# Remove the manually copied component
+rm -rf src/components/MarkdownActionsDropdown/
+```
+
+### 2. Update the Plugin
+
+```bash
+npm update docusaurus-markdown-source-plugin
+```
+
+### 3. Keep Your Custom CSS
+
+The CSS styles in `src/css/custom.css` remain unchanged - no action needed.
+
+### 4. Rebuild
+
+```bash
+npm run build
+npm run serve
+```
+
+**Note:** The plugin now bundles all components internally. If you had customizations to the copied files, you'll need to use Docusaurus's [swizzling](https://docusaurus.io/docs/swizzling) feature to override them.
+
 ## How It Works
 
 1. **Build Time**: The plugin processes all markdown files in `docs/` during build:
@@ -333,18 +348,19 @@ You can customize the dropdown appearance by overriding these CSS classes in you
 
 ### Dropdown Not Appearing
 
-1. **Check path configuration**: Ensure the component checks for the correct path. If your docs are at `/documentation/` instead of `/docs/`, edit `src/components/MarkdownActionsDropdown/index.js`:
-   ```javascript
-   const isDocsPage = currentPath.startsWith('/documentation/');
-   ```
+1. **Check plugin installation**: Ensure the plugin is in your `docusaurus.config.js` plugins array.
+
+2. **Rebuild your site**: After installing, run `npm run build` to ensure the plugin is loaded.
+
+3. **Check browser console**: Look for any errors that might indicate component loading issues.
 
-2. **Verify Root.js is being used**: Check browser console for errors. The file should be at `src/theme/Root.js`.
+4. **Verify path configuration**: The default path is `/docs/`. If your docs use a different path (e.g., `/documentation/`), you may need to swizzle the component and customize it.
 
-3. **Check DOM selector**: Open DevTools and run:
+5. **Check DOM structure**: Open DevTools and run:
    ```javascript
    document.querySelector('article .markdown header')
    ```
-   If it returns `null`, your theme has a different structure. Adjust the selector in `Root.js`.
+   If it returns `null`, your theme has a different structure and may require swizzling for customization.
 
 ### 404 When Accessing .md URLs
 
@@ -384,22 +400,16 @@ You can customize the dropdown appearance by overriding these CSS classes in you
 
 ### Using with Blog
 
-To enable markdown source viewing for your blog, modify the paths:
+To enable markdown source viewing for your blog:
 
-1. In `src/components/MarkdownActionsDropdown/index.js`:
-   ```javascript
-   const isDocsPage = currentPath.startsWith('/blog/');
+1. **Swizzle the components**: Use Docusaurus's swizzle feature to customize the bundled components:
+   ```bash
+   npm run swizzle docusaurus-markdown-source-plugin Root -- --eject
    ```
 
-2. In `src/theme/Root.js`:
-   ```javascript
-   if (!pathname.startsWith('/blog/')) return;
-   ```
+2. **Modify the swizzled files** to use blog paths instead of docs paths.
 
-3. Update the plugin to process blog files (modify `index.js` in the plugin):
-   ```javascript
-   const docsDir = path.join(context.siteDir, 'blog');
-   ```
+3. **Update plugin configuration**: You may need to extend the plugin to process blog files in addition to docs files.
 
 ### Custom URL Pattern
 

…ponents/MarkdownActionsDropdown/index.js …ponents/MarkdownActionsDropdown/index.jssrc/components/MarkdownActionsDropdown/index.js renamed to components/MarkdownActionsDropdown/index.js src/components/MarkdownActionsDropdown/index.js renamed to components/MarkdownActionsDropdown/index.js

@@ -184,6 +184,11 @@ module.exports = function markdownSourcePlugin(context, options) {
   return {
     name: 'markdown-source-plugin',
 
+    // Provide theme components from the plugin (eliminates need for manual copying)
+    getThemePath() {
+      return path.resolve(__dirname, './theme');
+    },
+
     async postBuild({ outDir }) {
       const docsDir = path.join(context.siteDir, 'docs');
       const buildDir = outDir;

index.js

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-markdown-source-plugin",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "A lightweight Docusaurus plugin that exposes your markdown files as raw .md URLs, perfect for LLMs and documentation tools",
   "main": "index.js",
   "keywords": [
@@ -38,7 +38,8 @@
   },
   "files": [
     "index.js",
-    "src/",
+    "theme/",
+    "components/",
     "README.md",
     "LICENSE",
     "CHANGELOG.md"

package.json

@@ -1,10 +1,10 @@
-// src/theme/Root.js
+// theme/Root.js - Plugin-provided theme component
 import React, { useEffect } from 'react';
 import { useLocation } from '@docusaurus/router';
 import { createRoot } from 'react-dom/client';
-import MarkdownActionsDropdown from '@site/src/components/MarkdownActionsDropdown';
+import MarkdownActionsDropdown from '../components/MarkdownActionsDropdown';
 
-function Root({ children }) {
+export default function Root({ children }) {
   const { hash, pathname } = useLocation();
 
   useEffect(() => {
@@ -69,5 +69,3 @@ function Root({ children }) {
 
   return <>{children}</>;
 }
-
-export default Root;