This repository serves as a starting point for building plugins that extend the functionality of
mdast2docx,@m2d/coreand@m2d/remark-docx.
This template offers the following pre-configured features. Additionally, your repository will automatically be re-branded with the help of workflows and post-install scripts.
✅ Monorepo powered by Turborepo and GitHub actions for automating building, testing, and deploying your plugin library
✅ Examples with Next.js, and Vite to showcase how your library can be utilized, also helps in quick manual testing
✅ Examples pre-configured for Light/Dark theme based on user preference
✅ Examples ready to be deployed to Vercel
✅ Code of Conduct and contributing files, ready for customization
✅ Prettier and linter configured according to modern best practices (Feel free to add your flavor)
✅ Recommended VSCode extensions - Prettier and Kanban board for code formatting and project management directly within your IDE
✅ Test setup with Vitest - A modern and fast testing framework supporting Jest-like APIs
✅ Workflows to automate testing on every pull-request or code push event
✅ Workflow to automatically publish and create GitHub releases when you update your library's package.json file.
✅ Workflow to automatically rebrand the entire template based on your repository name. (Refer TODO.md)
✅ Plus, this repo includes a quick checklist for configuring Codecov and other badges, setting up your docs website on GitHub pages, and more. See Checklist or open TKB(Workspace) if you have installed the Trello-Kanban-Board extension.
Star this repository and share it with your friends.
This template is based on Turborepo Template. But this one is optimized for md2docx plugins. It includes pre-configured unit-tests, a lot of extra stuff provided by the turborepo-template is removed, and comes with dependencies and scripts optimized for md2docx plugin development.
To get started, simply click on the "Use this template" button to create a new repository based on this template, and install dependencies. Customize it according to your requirements for your next md2docx plugin.
For detailed instructions and a checklist, please refer to TODO.md.
🤩 Don't forget to star this repository!
Looking for a hands-on course to get started with Turborepo? Check out React and Next.js with TypeScript and The Game of Chess with Next.js, React, and TypeScript
@m2d/core– Core MDAST to DOCX engine@m2d/remark-docx– Remark plugin- Unified Ecosystem – AST-based processors for markdown, html, etc.
- MDAST Spec – Markdown Abstract Syntax Tree
@m2d/math: Parse math blocks and convert to equation DOCX@m2d/image: Convert Markdown/HTML images to inline DOCX images@m2d/html: Parse raw HTML into extended MDAST with styles@m2d/table: Advanced table support with merged cells, widths, styles
If you’re building a plugin you'd like to share, let us know or open a PR in the mdast2docx plugins repo!
with 💖 by Mayank Kumar Chaudhari
