Skip to content

added feature of reference doc for template handling #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

SundaramManickam
Copy link
Contributor

Feature Description

Added support for pandoc's --reference-doc parameter in the MCP tool, allowing users to specify custom DOCX templates for styling their output documents.

Changes Made

  • Added reference_doc parameter to the tool's input schema
  • Updated documentation with usage examples
  • Added version bump to 0.3.4

Testing Done

  • Tested DOCX conversion with reference document
  • Verified parameter validation
  • Confirmed compatibility with existing pandoc functionality

Example Usage

{
  "input_file": "document.md",
  "output_format": "docx",
  "output_file": "output.docx",
  "reference_doc": "template.docx"
}

@vivekVells
Copy link
Owner

This got slipped. Thank you for contributing @SundaramManickam . I am looking into this now.

Copy link
Owner

@vivekVells vivekVells left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the PR. I would need to update the README a bit. Will merge it shortly after that.

Verified Functionality

Test document generation:

open /tmp/test.docx
Generated test document Document content view

Reference document creation:

pandoc -o /tmp/reference.docx --print-default-data-file reference.docx
open /tmp/reference.docx 
Reference document overview Reference document styles Style formatting details Document properties

✅ Template functionality working as expected

…ive documentation

- Add reference_doc parameter for custom DOCX template styling
- Implement validation for DOCX-only usage and file existence checks
- Add comprehensive CHEATSHEET.md with conversion matrix and examples
- Enhance README.md with bidirectional conversion matrix table
- Add cross-references between README and cheatsheet for better UX
- Include step-by-step workflows for professional document creation
- Update documentation with reference document examples and troubleshooting

Features:
- Support for pandoc --reference-doc parameter in DOCX conversions
- File existence validation and format restriction enforcement
- Backward compatibility maintained for existing functionality

Documentation:
- Complete 8x8 format conversion matrix showing 64 possible conversions
- Copy-paste examples for all supported formats and workflows
- Professional document creation workflows with custom styling
- Enhanced error handling documentation and troubleshooting guide

Closes vivekVells#20
@vivekVells
Copy link
Owner

Added cheat sheet and updated readme

@vivekVells vivekVells merged commit d9adaae into vivekVells:main Jun 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants