markdown-docs

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 19 Open GitHub ↗

VSCode WYSIWYG Markdown editor with inline comment support for AI interaction or personal notes.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Markdown Docs: Your Ultimate Markdown Companion

---

**Transform your Markdown workflow with Markdown Docs, a powerful VS Code extension designed for a seamless and intuitive document review and commenting experience.**

Whether you're collaborating with AI, taking personal notes, or working with a team, Markdown Docs provides the tools you need to streamline your process and focus on what matters most: your content.

![Markdown Docs Screenshot](https://raw.githubusercontent.com/jonnyasmar/markdown-docs/main/media/screenshot.png)

## ✨ Comprehensive Feature Overview

### 🎨 **Rich Text Editing**

- **WYSIWYG Editor** - State-of-the-art What You See Is What You Get editing powered by MDX Editor
- **Real-time Preview** - No context switching between raw Markdown and preview
- **Source View Toggle** - Switch between rich text and raw Markdown source
- **Diff View** - Compare different versions side-by-side

### 💬 **Interactive Commenting System**

- **Inline Comments** - Add comments directly within your Markdown using custom directives
- **Comment Sidebar** - Dedicated panel for managing all comments
- **Two-Way Navigation** - Click comments to jump to text, click text to see comments
- **Comment Management** - Edit, delete, and organize comments with ease
- **Collapsible Sidebar** - Resizable and hideable comment panel

### 🔍 **Advanced Search & Navigation**

- **Highlighted Search** - Real-time search with live highlighting as you type
- **Table of Contents** - Auto-generated navigation from document headings
- **Quick Jump** - Navigate through large documents effortlessly

### 📝 **Rich Content Support**

- **Admonitions** - Note, tip, danger, info, and caution callout blocks
- **Mermaid Diagrams** - Interactive diagram editor with live preview
- **Code Blocks** - Syntax highlighting with multiple language support
- **Tables** - Rich table editing and formatting
- **Images** - Drag-and-drop image support with automatic linking
- **Links** - Easy link creation and management
- **Lists** - Ordered, unordered, and checkbox task lists
- **Frontmatter** - YAML metadata support

### 🎯 **Customization & Theming**

- **Font Selection** - Choose from 13+ font families (Arial, Times New Roman, Roboto, Georgia, etc.)
- **Font Size Control** - Adjustable from 8px to 48px
- **Text Alignment** - Left, center, right, or justified alignment
- **Book View Mode** - Centered layout with customizable width and margins
- **Theme Integration** - Seamlessly follows VS Code's dark/light theme
- **Word Wrap** - Configurable based on VS Code editor settings

### ⌨️ **Productivity Features**

- **Keyboard Shortcuts** - Full VS Code keyboard shortcut integration
- **Auto-save** - Automatic document saving
- **Undo/Redo** - Complete edit history with granular control
- **Status Bar** - Real-time editor status and information

### 🔧 **Technical Capabilities**

- **Custom Editor** - Full VS Code custom editor integration
- **Multiple View Modes** - Rich text and source view
- **Extension Commands** - "Open with Markdown Docs", "New Markdown Docs File"
- **Context Menu Integration** - Right-click options in file explorer
- **Frontmatter Processing** - Proper handling of YAML document metadata

## Use Cases

### AI Collaboration

In the age of AI-driven development and content creation, **Markdown Docs** provides a crucial bridge for human-AI interaction. Use it to:

- **Leave feedback for AI models:** Add comments and annotations to AI-generated markdown to guide and refine the output.
- **Document AI-related workflows:** Keep track of AI-powered analyses, plans, and documentation.
- **Structure your thoughts:** Use the commenting feature to organize your ideas and feedback on AI-generated content.

### Personal Note-Taking

**Markdown Docs** is also a great tool for personal note-taking. Use it to:

- **Annotate articles and documents:** Add your own notes and thoughts to markdown files.
- **Keep a personal journal:** The commenting feature can be used to add dated entries or reflections to the notes.
- **Organize your research:** Keep track of your sources and ideas by adding comments to your research notes.

### Team Collaboration

While not a full-fledged real-time collaboration tool, **Markdown Docs** can be used for asynchronous team collaboration:

- **Code reviews for documentation:** Leave comments and feedback on documentation files in a similar way to code reviews.
- **Share feedback on drafts:** Share markdown files with your team and use the commenting feature to gather feedback.
- **Track changes and suggestions:** The commenting feature provides a clear and organized way to track suggestions and changes.

## We're Open to Feature Requests!

We're always looking for ways to improve Markdown Docs. If you have a feature request or an idea for how we can make the extension better, please don't hesitate to let us know! We're open to all suggestions and contributions.

## Installation

1. Open the **Extensions** view in VS Code.
2. Search for "Markdown Docs".
3. Click **Install**.

## Usage

- **Open with Markdown Docs:** Right-click on a markdown file in the explorer and select "Open with Markdown Docs".
- **Add a comment:** Select a piece of text and click the comment icon in the gutter.
- **Edit a comment:** Click on a comment to edit it.
- **Delete a comment:** Click the delete button on a comment.

## License

This extension is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.

markdown-docs

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

markdown-docs

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README