Skip to content

This tool allows you to create Markdown formatted code snippets. You can input a title, description, and the code snippet itself. The tool will generate the Markdown version of your code snippet, which you can preview and download as a Markdown file. This is particularly useful for developers who want to share their code in a readable

Notifications You must be signed in to change notification settings

HARISHKUMAR023/generate-markdown-code-snippets

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logo

Markdown Code Snippet Generator

This tool allows you to create Markdown formatted code snippets. You can input a title, description, and the code snippet itself. The tool will generate the Markdown version of your code snippet, which you can preview and download as a Markdown file. This is particularly useful for developers who want to share their code in a readable and standardized format.

How to Use

  1. Open the HTML file in a web browser.
  2. Input your code title, description, and the code snippet in the respective fields.
  3. Click the "Generate Markdown" button to generate the Markdown version of your code snippet. The generated Markdown will be displayed in the Markdown preview section.
  4. If you want to download the generated Markdown, input a file name and click the "Download Markdown" button. The Markdown file will be downloaded to your default download location.

Features

  • Generate Markdown formatted code snippets
  • Preview the generated Markdown
  • Download the generated Markdown as a Markdown file

Future Enhancements

  • Add support for different programming languages
  • Improve the UI/UX
  • Add more customization options for the generated Markdown

Contributing

We welcome contributions to the Markdown Code Snippet Generator! Here's how you can help:

  1. Fork the repository. Click the 'Fork' button at the top right of the page and clone your forked repository to your local machine.

  2. Create a branch. From your terminal, create a new branch for the feature or fix you want to work on. For example: git checkout -b feature/add-python-support.

  3. Make your changes. Make the changes you want to contribute. Please try to follow the existing code style.

  4. Commit your changes. Commit your changes with a descriptive commit message.

  5. Push your changes. Push your changes to your forked repository on GitHub.

  6. Create a pull request. From your forked repository on GitHub, click the 'New pull request' button. Ensure your pull request is made against the 'main' branch of the Markdown Code Snippet Generator repository.

Before contributing, please read our Code of Conduct. We expect all contributors to respect these guidelines.

Thank you for your interest in contributing to the Markdown Code Snippet Generator!

About

This tool allows you to create Markdown formatted code snippets. You can input a title, description, and the code snippet itself. The tool will generate the Markdown version of your code snippet, which you can preview and download as a Markdown file. This is particularly useful for developers who want to share their code in a readable

Topics

Resources

Code of conduct

Stars

Watchers

Forks

Packages

No packages published