Orgdown for VS Code

OrgMode is the only reason I still keep Emacs on my device; that's why this extension was created.

About The Project

Welcome to Orgdown! This is a Visual Studio Code extension dedicated to bringing the legendary organizational power of Emacs' Org Mode to the modern, accessible environment of VS Code. Our mission is to faithfully implement 80% or more of the core Org Mode feature set, focusing on robust syntax highlighting, code block execution, and task management.

This project is built with a professional-grade, test-driven architecture to ensure stability and maintainability.

Learn more at our project websites: orgdown.com & orgdown.org.

Features & Roadmap

We are systematically implementing the full Org Mode feature set. To see a detailed list of currently supported features, as well as our development roadmap for what's coming next, please consult our Feature Coverage Dashboard.

Getting Started

Simply install the "Orgdown" extension from the Visual Studio Code Marketplace.

How to Contribute

We welcome and encourage community contributions!

To get started, please read our comprehensive Contribution Guide. It contains everything you need to know about our architecture, testing philosophy, and step-by-step processes.

Our Architectural Philosophy

For those interested in the engineering principles behind the project, we follow a strict, documentation-driven design process:

• The "Why": Our overall system design is detailed in our Architecture Document.
• The "How": Our development process is detailed in the Contribution Guide.
• Specific Decisions: Significant, specific design decisions are documented in our Architecture Decision Records (ADRs), located in docs/architecture_decisions/.

License

This project is licensed under the MIT License.