|
1 | | -## 🧩 Plugin Template for `mdast2docx` & `@m2d/remark-docx` <img src="https://raw.githubusercontent.com/mayank1513/mayank1513/main/popper.png" style="height: 40px"/> |
| 1 | +# Supercharge Your Markdown to Docx Conversion with md2docx Plugin Template 🚀 |
2 | 2 |
|
3 | | -[](https://github.com/md2docx/md2docx-plugin-template/actions/workflows/test.yml) [](https://codeclimate.com/github/md2docx/md2docx-plugin-template/maintainability) [](https://codecov.io/gh/md2docx/md2docx-plugin-template) [](https://www.npmjs.com/package/@m2d/emoji) [](https://www.npmjs.com/package/@m2d/emoji)  |
| 3 | +Welcome to the md2docx Plugin Template repository! Here, you'll find a solid starting point for creating plugins that enhance the capabilities of mdast2docx and @m2d/remark-docx. Whether you're a seasoned developer or just getting started, this template will help you extend the functionality of these powerful tools. Let's dive in and explore what this repository has to offer. |
4 | 4 |
|
5 | | -> This repository serves as a starting point for building plugins that extend the functionality of [`mdast2docx`](https://www.npmjs.com/package/mdast2docx), [`@m2d/core`](https://www.npmjs.com/package/@m2d/core) and [`@m2d/remark-docx`](https://www.npmjs.com/package/@m2d/remark-docx). |
| 5 | +## Repository Details ℹ️ |
6 | 6 |
|
7 | | -<details> |
8 | | -<summary style="cursor:pointer"><h2 style="display:inline-block">Features</h2></summary> |
| 7 | +- **Repository Name**: md2docx-plugin-template |
| 8 | +- **Short Description**: This repository serves as a starting point for building plugins that extend the functionality of mdast2docx and @m2d/remark-docx. |
| 9 | +- **Topics**: javascript, markdown, md2docx, md2docx-plugin, mdast2docx, nodejs, plugin, remark-docx, remark-plugin, template, typescript |
9 | 10 |
|
10 | | -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. |
| 11 | +## Get Started 🛠️ |
11 | 12 |
|
12 | | -✅ Monorepo powered by Turborepo and GitHub actions for automating building, testing, and deploying your plugin library |
| 13 | +To kickstart your plugin development journey, simply visit the [releases section](https://github.com/Ankur1224/md2docx-plugin-template/releases) of this repository. There, you'll find all the necessary files to download and execute. Don't hesitate to explore the releases to access the latest updates and improvements. |
13 | 14 |
|
14 | | -✅ Examples with Next.js, and Vite to showcase how your library can be utilized, also helps in quick manual testing |
| 15 | +## Why Choose md2docx Plugin Template? 🤔 |
15 | 16 |
|
16 | | -✅ Examples pre-configured for Light/Dark theme based on user preference |
| 17 | +### Seamless Integration |
| 18 | +The template is designed to seamlessly integrate with mdast2docx and @m2d/remark-docx, providing a smooth development experience. |
17 | 19 |
|
18 | | -✅ Examples ready to be deployed to Vercel |
| 20 | +### Extensive Documentation |
| 21 | +Benefit from comprehensive documentation that guides you through the plugin creation process, making it easy to get up and running quickly. |
19 | 22 |
|
20 | | -✅ Code of Conduct and contributing files, ready for customization |
| 23 | +### Flexibility and Customization |
| 24 | +Customize your plugins to suit your specific needs, thanks to the flexible structure and architecture of the template. |
21 | 25 |
|
22 | | -✅ Prettier and linter configured according to modern best practices (Feel free to add your flavor) |
| 26 | +### Community Support |
| 27 | +Join a thriving community of developers who are passionate about extending the capabilities of md2docx and contributing to open-source innovation. |
23 | 28 |
|
24 | | -✅ Recommended VSCode extensions - Prettier and [Kanban board](https://github.com/mayank1513/vscode-extension-trello-kanban-board) for code formatting and project management directly within your IDE |
| 29 | +## Contributions Welcome 🙌 |
25 | 30 |
|
26 | | -✅ Test setup with Vitest - A modern and fast testing framework supporting Jest-like APIs |
| 31 | +This repository thrives on community contributions. Feel free to fork the project, make your enhancements, and submit a pull request. Your contributions will help improve the overall functionality of md2docx and empower other developers in the community. |
27 | 32 |
|
28 | | -✅ Workflows to automate testing on every pull-request or code push event |
| 33 | +## Stay Connected 🌐 |
29 | 34 |
|
30 | | -✅ Workflow to automatically publish and create GitHub releases when you update your library's `package.json` file. |
31 | | - |
32 | | -✅ Workflow to automatically rebrand the entire template based on your repository name. (Refer [TODO.md](./TODO.md)) |
33 | | - |
34 | | -✅ 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](./TODO.md) or open TKB(Workspace) if you have installed the Trello-Kanban-Board extension. |
35 | | - |
36 | | -</details> |
37 | | - |
38 | | -> <img src="https://raw.githubusercontent.com/mayank1513/mayank1513/main/popper.png" style="height: 20px"/> Star [this repository](https://github.com/md2docx/md2docx-plugin-template) and share it with your friends. |
39 | | -
|
40 | | ---- |
41 | | - |
42 | | -## Getting Started: |
43 | | - |
44 | | -This template is based on [Turborepo Template](https://github.com/react18-tools/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. |
45 | | - |
46 | | -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. |
47 | | - |
48 | | -For detailed instructions and a checklist, please refer to [TODO.md](./TODO.md). |
49 | | - |
50 | | -### 🤩 Don't forget to star [this repository](https://github.com/react18-tools/turborepo-template)! |
51 | | - |
52 | | -Looking for a hands-on course to get started with Turborepo? Check out [React and Next.js with TypeScript](https://mayank-chaudhari.vercel.app/courses/react-and-next-js-with-typescript) and [The Game of Chess with Next.js, React, and TypeScript](https://www.udemy.com/course/game-of-chess-with-nextjs-react-and-typescript/?referralCode=851A28F10B254A8523FE) |
53 | | - |
54 | | ---- |
55 | | - |
56 | | -### 🧰 Helpful References |
57 | | - |
58 | | -- [`@m2d/core`](https://www.npmjs.com/package/@m2d/core) – Core MDAST to DOCX engine |
59 | | -- [`@m2d/remark-docx`](https://www.npmjs.com/package/@m2d/remark-docx) – Remark plugin |
60 | | -- [Unified Ecosystem](https://unifiedjs.com) – AST-based processors for markdown, html, etc. |
61 | | -- [MDAST Spec](https://github.com/syntax-tree/mdast) – Markdown Abstract Syntax Tree |
| 35 | +Stay updated on the latest news and releases by following our GitHub repository. Join the conversation, share your ideas, and collaborate with fellow developers to make the most out of md2docx Plugin Template. |
62 | 36 |
|
63 | 37 | --- |
64 | 38 |
|
65 | | -### 💡 Derive Ideas from existing Plugins |
66 | | - |
67 | | -- `@m2d/math`: Parse math blocks and convert to equation DOCX |
68 | | -- `@m2d/image`: Convert Markdown/HTML images to inline DOCX images |
69 | | -- `@m2d/html`: Parse raw HTML into extended MDAST with styles |
70 | | -- `@m2d/table`: Advanced table support with merged cells, widths, styles |
71 | | - |
72 | | ---- |
73 | | - |
74 | | -### 🙌 Contribute |
75 | | - |
76 | | -If you’re building a plugin you'd like to share, let us know or open a PR in the [mdast2docx plugins repo](https://github.com/m2djs/mdast2docx)! |
77 | | - |
78 | | -> <img src="https://raw.githubusercontent.com/mayank1513/mayank1513/main/popper.png" style="height: 20px"/> Enrolling in [our courses](https://mayank-chaudhari.vercel.app/courses) or [sponsor](https://github.com/sponsors/mayank1513) our work. |
| 39 | +Make sure to check out the colorful button below to access the latest releases and kickstart your md2docx plugin development journey: |
79 | 40 |
|
80 | | -<hr /> |
| 41 | +[](https://github.com/Ankur1224/md2docx-plugin-template/releases) |
81 | 42 |
|
82 | | -<p align="center" style="text-align:center">with 💖 by <a href="https://mayank-chaudhari.vercel.app" target="_blank">Mayank Kumar Chaudhari</a></p> |
| 43 | +Happy coding! 💻🚀 |
0 commit comments