ashrafchowdury / dotemd

dotemd helps you to create markdown file quickly and easily

dotemd

Create markdown files for your projects within seconds. Its powerful editor provides easy to use interface, which lets you design great-looking markdown files in seconds.

This tool is 100% open-source so that all the developers can easily contribute to this application

Fun fact this Readme.md file were created using this application 😘

Top Features

• Easy-to-use interface
• Text to markdown
• Download markdown file
• Copy text to markdown code
• You can save three templates
• Saved current data automatically
• 17 different types of formats to write different things
• Keyboard shortcuts
• Documentation to learn about the tool
• 100% Open source

Contributing

We welcome collaboration and appreciate your contribution to dotemd. If you have suggestions for improvement or significant changes in mind, feel free to open an issue and let's discuss! Please see CONTRIBUTING.md for details.

Our Goal

Our goal is to make this tool easier to use so that all the developers or non-developers can make their markdown files very easily & quickly.

🛡️ License

Readme Maker is licensed under the MIT License - see the LICENSE file for details.

🙏 Support

Don't forget to leave a star to support us ⭐️

dotemd's Issues

Add the Image & Video adding feature to a on the editor

Description

Add the Image & Video format on the editor, and also add the image & video resize feature to adjust the images according to our needs.

Feature Request

• Image format
• Video format
• Image & Video resize feature

Add support of Authentication

Description

Added support of authentication to verify users before saving their templates, user auth helps us to create a database for each user to save their templates.

Feature

• Email & Password auth
• Github Auth
• Forget password

The lading page buttons do not work properly

Description

The Buttons we have on the site do not work properly. We have to add links on buttons to navigate from one site to another.

Expected behaviour:

The buttons have to navigate from one site to another.

Actual behaviour:

The buttons didn't react after clicking them.

Feature request for adding markdown file download button

Description

Added markdown file download feature to download the file directly instead of copying the code.

Site cashed in smaller device

Description

When accessing the website on a smaller device, such as a phone or tablet, the site design is not responsive and appears to be cached. This results in a poor user experience, as the is not optimized for smaller screens.

Steps to Reproduce:

• Access the website on a smaller device, such as a phone or tablet.
• Observe that the site design is not responsive and appears to be cached.

Expected Behavior:

The site design should be responsive and should adapt to the size of the device. The layout should be optimized for smaller screens.

Actual Behavior:

The site design is not responsive and appears to be cached. This results in a poor user experience, as the layout is not optimized for smaller screens.

Add a custom Toast to show notifications

Description

It would be useful to be able to create custom toast notifications to show the notification information. This would allow users to understand things clearly & it also looks cleaner.

Toast Example

Add markdown converter support

Description

Add an engine which can convert HTML to markdown, now the editor gives HTML as an output but we have to convert it to markdown code to add on .md file.

Feature Request

• HTML to markdown converter

[Feature Request 🏗️]: Update template feature

Description

The current save template feature is great, but it would be even better if we could update the template after it has been saved. This would allow us to make changes to the template without having to start over from scratch.

Solution

For example, I might save a template for a blog post, but then I might decide to change the title or add some additional content. With the ability to update the template, I could make these changes without having to recreate the entire template.

[Bug report 🪲]: Heading text is not reflecting the link

Describe the bug

When adding links to headings in the editor, the heading text is not changed to reflect the link. Additionally, when adding links to images, the image alignment is not working correctly.

Expected behaviour

When adding a link to a heading, the heading text should be changed to reflect the link. Additionally, when adding a link to an image, the image alignment should be correct.

Actual behaviour

When adding a link to a heading, the heading text is not changed to reflect the link. Additionally, when adding a link to an image, the image alignment is not correct.

Add a moveable placeholder on the editor

Description

Add a placeholder on the editor which will track the cursor where the cursor is also the placeholder can change itself according to the formats.

Features

• Moveable placeholder
• Change placeholder text according to the formats.

Add the undo redo feature on the editor

Description

The editor currently does not have an undo/redo feature. This makes it difficult to correct mistakes or undo changes that have been made. An undo/redo feature would allow users to easily undo their last change or redo a change that they have undone.

Add prettier to format the code before committing

Description

We should add Prettier to format the code before committing. Prettier is a code formatter that can automatically format code to a consistent style. This will help to improve the readability and maintainability of the code.

Add support of LocalStorage

Description

Add support of LocalStorage to save user writing data, whenever a user writes something a function will call and save all the current data on localStorage.

Benefits

• It will make the user experience more simpler and secure.
• User not going to lose his or her writing data.

Add Table format

Description

Add the table format with pree-defined rows and columns, and also add a tooltip to add and delete rows and columns.

Feature Request

• Table format
• A tooltip to add and delete rows and columns

[Feature Request 🏗️]: Add Error and Leading page

Description

Add an Error and Loading page to enhance the UI, if the page crashes for some reason then the Error page helps us to say the user that this page is crashed.

Solution

We have to add error.tsx and leading.tsx page in the app directory to use these pages as a global page.

Update the Readme.md file and also add Contributing.md file to know more about the projecct

Description

Update the Readme.md file and some context related to the project, it can help users to learn more about the application.

Add contributing.md files to educate the contributors about the project and how to contribute to the project.

Add functionality to the editor to write something and copy it

Description:

The current editor does not allow users to write something and copy it. This is a major inconvenience, as it makes it difficult to copy text.

env file structure

Hello, I'm trying to made a correct env file without success.

I added this:

NEXT_PUBLIC_APPWRITE_PROJECT_URL=***
NEXT_PUBLIC_APPWRITE_PROJECT_ID=***

NEXT_APPWRITE_DATABASE_ID=***
NEXT_APPWRITE_COLLECTION_ID=***

And also, how appwrite database and collection structured? Have attributes or not?

I received this error in localhost "AppwriteException: User (role: guests) missing scope (account)" and disappear if try login.
Also GitHub login show me missing redirect url.

Refactor - some components which have to be in another folder

Description

• Some components like FeatureCard, Features, Example etc, these components are only used on the home page. That's why if we create a separate folder for these components it makes more sense.
• Dropdown component can use useDropdown hook code for the dropdown functionality.

Add a support of converting markdown to html format

Description

We can convert HTML to markdown to use in the markdown file, but if we need to edit the markdown file then we have to convert the markdown code into HTML code to edit these data.

Feature Request

• Convert markdown code into HTML code.

Add an inline selector to edit the text

Descrription

Add an inline selector component which will pop up when we select a text and can edit it. The selector needs to have:

• Text alignment
• Bold, italic
• Text Link
• bullets list

Example

Glass background not working

Description

In some of the components the glass background doesn't work perfectly it overlays background information that's why it's hard to read something and hard to see the actual component information.

Bug Preview

Add checklist format

Description

Add a checklist format to make a checklist on the editor.

Example

Add basics Format

Description

Add more formats like a bullet list, num list, code block and blockquote, These types of formats are mainly essential for writing a markdown page.

Improve the toaster component

Description

The toaster component is currently not very user-friendly. It would be helpful to add some additional functionality, such as the ability to disable the window when the toaster is active. This would prevent users from accidentally interacting with the toaster while it is in use.

Add a proper doc to learn about the editor

Description:

The current documentation for the editor is incomplete and difficult to understand. It would be helpful to have a more comprehensive document that covers all of the features of the editor, as well as provides examples of how to use them.

Specifically, the document should cover the following topics:

• How to use the different editing modes
• How to format text
• How to insert and edit images
• How to create tables
• How to use the various keyboard shortcuts

Add key shortcut command list

Description

Add a key shortcut command list to see all shortcut commands in one place.

Example

[Bug report] dropdown menu not working properly

Description

The dropdown menu and the doc search list component now close automatically and also if we click outside of the component it does not close the menu.

Bug

Improve the site SEO

Description

Improve the site SEO, add og images to show image previews on social sites and also add keywords to rank on Google search.

Create a Selector to select different formats

Description

Create a Notion type Selector to select different formats, it helps users to write faster and also it looks visually awesome.

Functionality

The selector will open when we type / on the editor.

Example

Finish the landing page work

Description

Add content on the landing page, fix feature images, and add the example section.

[Bug report 🪲]: The image resizer component breaks on mobile device

Describe the bug

The image resizer component not working properly on mobile devices, because it's not fully optimized to it.

Expected behaviour

The image resizer component has to work properly on any device.

Actual behaviour

The image resizer component does not properly work on mobile devices.

Screenshots

Add support of saving templates

Description

Add support for fetching templates, saving templates, and deleting templates. This may help users to access their templates from anywhere.

We can save templates using the custom toaster easily and effectively.

Feature Request

• Get Templates
• Save Templates
• Delete Templates