Skip to content

Commit 77336d5

Browse files
FlyNumberclaude
andcommitted
Initial release v1.0.0 - npm package structure
- Add package.json with proper metadata and dependencies - Add main plugin file (index.js) for build-time markdown processing - Add React components (MarkdownActionsDropdown and Root.js theme override) - Add comprehensive README with installation and deployment guides - Add CHANGELOG for v1.0.0 - Add .npmignore to exclude development files - Update README with package information and live example Features: - Build-time plugin for copying and cleaning markdown files - Dropdown UI component for viewing/copying markdown - Mobile-responsive design with RTL support - SEO-safe with proper header configurations - Zero-config setup with sensible defaults - Comprehensive deployment guides for all major platforms 🤖 Generated with Claude Code Co-Authored-By: Claude <[email protected]>
1 parent 042b662 commit 77336d5

File tree

7 files changed

+1007
-2
lines changed

7 files changed

+1007
-2
lines changed

.npmignore

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Development files
2+
.claude/
3+
.git/
4+
.gitignore
5+
node_modules/
6+
7+
# Test files
8+
test/
9+
tests/
10+
*.test.js
11+
*.spec.js
12+
13+
# Documentation (keep README.md, CHANGELOG.md, LICENSE)
14+
docs/
15+
examples/
16+
17+
# OS files
18+
.DS_Store
19+
Thumbs.db
20+
21+
# Editor files
22+
.vscode/
23+
.idea/
24+
*.swp
25+
*.swo
26+
*~
27+
28+
# Build artifacts
29+
*.log
30+
npm-debug.log*
31+
yarn-debug.log*
32+
yarn-error.log*

CHANGELOG.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [1.0.0] - 2025-11-24
9+
10+
### Added
11+
- Initial release of docusaurus-markdown-source-plugin
12+
- Build-time plugin that copies markdown files to build output
13+
- Automatic cleaning of Docusaurus-specific syntax (front matter, imports, MDX components)
14+
- Conversion of HTML elements back to markdown equivalents
15+
- Conversion of relative image paths to absolute paths from /docs/ root
16+
- Automatic copying of image directories to build output
17+
- React dropdown component for viewing and copying markdown
18+
- "View as Markdown" feature - opens raw markdown in new tab
19+
- "Copy Page as Markdown" feature - copies markdown to clipboard
20+
- Dynamic injection into article headers via Root.js theme override
21+
- Click-outside-to-close dropdown behavior
22+
- Mobile-responsive dropdown positioning
23+
- RTL language support for dropdown menu
24+
- Comprehensive deployment guides for:
25+
- Vercel
26+
- Netlify
27+
- Cloudflare Pages
28+
- Apache
29+
- Nginx
30+
- SEO-safe HTTP headers configuration examples
31+
- CSS customization support via custom.css
32+
- Support for Tabs/TabItem component conversion
33+
- Support for details/summary component conversion
34+
- YouTube iframe to text link conversion
35+
- HTML5 video tag handling
36+
- Zero-config setup with sensible defaults
37+
38+
### Documentation
39+
- Comprehensive README with installation instructions
40+
- Quick start guide
41+
- Deployment configuration for all major platforms
42+
- Troubleshooting guide
43+
- Advanced configuration examples (blog support, custom URL patterns)
44+
- CSS customization guide
45+
- Live example at flynumber.com/docs
46+
47+
### Technical Details
48+
- Dependencies: fs-extra ^11.0.0
49+
- Peer dependencies: @docusaurus/core ^3.0.0, react ^18.0.0
50+
- Requires Node.js >=18.0.0
51+
- Compatible with Docusaurus v3.x
52+
- Uses React 18's createRoot API for component injection
53+
54+
[1.0.0]: https://github.com/FlyNumber/markdown_docusaurus_plugin/releases/tag/v1.0.0

0 commit comments

Comments
 (0)