Overview
dotemd is an efficient and feature-rich application that simplifies the creation of markdown files. It empowers users with a user-friendly interface, multiple formatting options, essential features, and a commitment to openness and collaboration.
Editor
dotemd's editor allows you to effortlessly design stunning markdown files with over 17 text formats, keyboard shortcuts, and text-to-markdown conversion capabilities.
Formats
You have access to 17 different text formats, including headings, lists, quotes, code blocks, images, tables, and more., here is the list of all formats:
| Format | Use Case | Keyboard Shortcut |
|---|---|---|
| Heading 1 | Main section or title | Ctrl + Alt + 1 |
| Heading 2 | Subsection or subheading | Ctrl + Alt + 2 |
| Heading 3 | Subsection within a subsection | Ctrl + Alt + 3 |
| Bullet List | Unordered list items | Ctrl + Shift + 8 |
| Number List | Ordered list items | Ctrl + Shift + 7 |
| Check List | Task list items with checkboxes | Ctrl + Shift + 9 |
| Block Quote | Quoted text or excerpts | Ctrl + Shift + B |
| Code Block | Displaying code snippets | Ctrl + Alt + C |
| Image | Inserting images | N/A |
| Table | Creating tabular data | Ctrl + Alt + T |
| Horizontal Rule | Separating sections or content | Ctrl + Alt + H |
| Bold | Emphasizing important text | Ctrl + B |
| Italic | Indicating emphasis or citations | Ctrl + I |
| Code | Highlighting inline code | Ctrl + E |
| Left align | Aligning text to the left | Ctrl + Shift + L |
| Center align | Aligning text to the center | Ctrl + Shift + E |
| Right align | Aligning text to the right | Ctrl + Shift + R |
| Undo | Reverting the most recent action | Ctrl + Z |
| Redo | Reapplying the most recently undone action | Ctrl + Y |
Selectors
We have notion like selectors component for selecting different types of formats. We have two different selector currently:
- Main selector which open's when we click '/' button on keyboard.
- Text selector open's when we select text.
Editor Menu
Template Examples
Explore the power of dotemd with our templates provide a live example to kickstart your markdown file creation process.
Contribution
We welcome contributions to dotemd! This document outlines is the guidelines for installation of this project. Please see CONTRIBUTING.md for details.
Installation
- Clone the Repo
git clone https://github.com/ashrafchowdury/dotemd.git
- Move to the project
cd dotemd
- Install dependencies
npm install
- Setup .env file
NEXT_APPWRITE_DATABASE_ID=
NEXT_APPWRITE_COLLECTION_ID=
//optional
NEXT_PUBLIC_APPWRITE_PUBLIC_DATABASE_ID=
NEXT_PUBLIC_APPWRITE_PUBLIC_COLLECTION_ID=
- Run the application
npm run dev
- After changes Run
npm run format
Conclusion
In conclusion, dotemd is a powerful tool for creating markdown files with ease. Its user-friendly interface, combined with a wide range of formatting options, allows you to design visually appealing markdown documents in seconds. Whether you're working on a project documentation, writing blog posts, dotemd has got you covered everything related to markdown.