Skip to content

Unleash the power of our pre-production extension, transforming your Markdown writing experience. Compose Markdown effortlessly with a user-friendly GUI, while enjoying real-time previewing. Generate files or seamlessly copy to platforms like GitHub. Stay tuned for the official release and revolutionize your Markdown workflow like never before.

License

Notifications You must be signed in to change notification settings

sharafdin/markdown-master

Repository files navigation

Markdown Master - Visual Studio Code Extension

Markdown Master Logo

Markdown Master is a powerful Visual Studio Code extension that elevates your Markdown editing experience to new heights. Developed by Sharafdin, this open-source extension is designed to provide a user-friendly graphical interface for writing Markdown, while seamlessly integrating a real-time preview feature. Say goodbye to flipping between different views and embrace a smoother, more intuitive way to create and edit your Markdown files.

Features

  • GUI Markdown Editor: Markdown Master brings the simplicity and familiarity of a graphical user interface to your Markdown writing process. No more worrying about complex syntax or formatting issues. With our GUI editor, you can focus on your content while we handle the rest.

  • Live Preview: See your Markdown content come to life in real-time with the built-in preview feature. As you write, the preview panel will update automatically, allowing you to visualize your changes as you type.

  • Enhanced Productivity: Markdown Master empowers you to generate new files effortlessly, making the creation of Markdown documents a breeze. Furthermore, you can seamlessly copy and paste your Markdown content to various platforms, including GitHub, making collaboration and sharing hassle-free.

  • Intuitive Interface: Designed with simplicity and ease of use in mind, Markdown Master provides an intuitive and clean interface. No steep learning curves or complicated settings – start using it right away and enjoy a smooth writing experience.

Installation

  1. Open Visual Studio Code.
  2. Go to the Extensions view by clicking on the Extensions icon in the Activity Bar on the side of the window.
  3. Search for "Markdown Master" in the Extensions view search box.
  4. Click on the "Install" button to install the extension.
  5. (Optional) Once installed, click on the "Reload" button (if it needed) to activate Markdown Master in your Visual Studio Code environment.

Usage

  1. Open a foleder (e.g., my-projects) in Visual Studio Code.
  2. Click on the "Markdown Master" icon in the top toolbar to open the GUI Markdown Editor.
  3. Start writing your Markdown content using the GUI interface.
  4. Click preview button and observe the live preview of your Markdown in the right-hand panel.
  5. Click and utilize the "Generate File" option to create new Markdown files effortlessly.
  6. Or copy and paste your Markdown content to any desired platform or repository, including GitHub, for seamless sharing.

Contributing

Contributions to Markdown Master are welcome! Please refer to our Contributor's Guide and Code of Conduct for more details.

We welcome contributions to Markdown Master! To get involved, please:

  1. First read our Contributor's Guide and Code of Conduct for more details.
  2. Fork the repository on GitHub.
  3. Clone your fork to your local development environment.
  4. Create a new branch for your feature or bug fix.
  5. Make your changes and commit them with descriptive commit messages.
  6. Push your changes to your forked repository.
  7. Submit a pull request back to the original repository.

Sponsor Markdown Master

Support the development and continuous improvement of Markdown Master by becoming a sponsor. Your generous contributions enable us to maintain, enhance, and add new features to the extension, benefiting the entire user community. Sponsors play a crucial role in ensuring the longevity and sustainability of this open-source project.

Why Sponsor?

  • Empower the Community: By sponsoring Markdown Master, you contribute to an extension that benefits countless developers, writers, and content creators worldwide. Your support directly impacts the productivity and creativity of users.

  • Faster Improvements: Sponsorships enable us to allocate more time and resources to the extension's development. This means faster updates, bug fixes, and new features that align with your needs and preferences.

  • Recognition and Exposure: As a sponsor, your name or organization will be prominently featured in the extension's documentation and repository. This exposure provides an excellent opportunity to showcase your commitment to open-source and the developer community.

Sponsorship Guidelines

We appreciate and value every sponsorship contribution made to Markdown Master. To ensure a harmonious and inclusive sponsorship program, we kindly ask sponsors to adhere to the following guidelines:

  • Respect and Inclusivity: We strive to maintain a welcoming and inclusive community for all users and sponsors. Please engage in respectful and constructive interactions with other members.

  • No Discrimination: We do not tolerate any form of discrimination, harassment, or offensive behavior within our community. Sponsors are expected to abide by our Code of Conduct.

  • Transparency: We are committed to transparency in our financial dealings. Sponsors can access reports on how their contributions are utilized to support the extension's development.

How to Sponsor

To become a sponsor and support the Markdown Master extension, follow these steps:

  1. Go to our Sponsor Page on GitHub.
  2. Choose the sponsorship tier that aligns with your preferred level of support.
  3. Complete the sponsorship process as directed on the page.

Thank you for considering sponsoring Markdown Master. Your support enables us to continue providing an exceptional Markdown writing experience to users everywhere.

Support

If you encounter any issues or have questions regarding Markdown Master, please open an issue on our GitHub repository. We are eager to assist and improve the extension for a better user experience.

License

Markdown Master is an open-source extension licensed under the MIT License.


Thank you for choosing Markdown Master! We hope you enjoy using it and have a pleasant Markdown writing experience with the power of GUI and live preview.

About

Unleash the power of our pre-production extension, transforming your Markdown writing experience. Compose Markdown effortlessly with a user-friendly GUI, while enjoying real-time previewing. Generate files or seamlessly copy to platforms like GitHub. Stay tuned for the official release and revolutionize your Markdown workflow like never before.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published