Skip to content

Latest commit

 

History

History
105 lines (82 loc) · 6.65 KB

README.md

File metadata and controls

105 lines (82 loc) · 6.65 KB
Raw

Org Extended

Org

OrgMode is a lifestyle. While I like sublime, living without Org Mode has been something that has driven me back to Emacs over and over again. I finally decided that I might take a stab at building a usable orgmode plugin for sublime.

The package can be found at: OrgExtended

Start

NOTE: To get setup, please jump down the Setup link below.

When people show off org, they often just show off some folding and the ability to tab cycle a headings tree. This often leads people to compare org with Markdown. Org IS a markup and document interchange format like markdown, but it is also much more.

Folding

Fundamentally org mode is 2 very /different/ things and fairly hard to describe:

  1. Org Files - A text based document markup language similar to markdown.
  2. Org Mode - A wide variety of tools for operating on and working with collections of these files.
  3. Org Extensions - I know I said 2 but Org Mode has a wide variety of tools built around the mode and api's extending it in many creative ways. Although not org mode itself most people refer to these tools when they think of org mode.

Org Mode can and has been used for a large variety of things:

  • A Personal Wiki
  • Professional Notes
  • Time Tracking and Billing
  • Documentation
  • Research Papers - Dynamic Documents
  • Literate Programming
  • Personal Agenda
  • Project Planning
  • As a blogging tool
  • Website content management
  • A means of planning and managing a budget with ledger mode
  • As a process and memory aid for IT professionals
  • As a self documenting configuration file for emacs itself (and other things).
  • Many many more things

What makes Org Mode so versatile is the deceptive simplicity of the format the flexibility of the simple markup and the the depth of the tools and API's provided around that format.

At times I have wondered why I shouldn't just use markdown? It is a much more widely popular markup system. There is no reason markdown could not be extended to become exactly what Org Mode has become, but markdown is not quite as flexible with its meta data and has not had the same degree of cult following so has yet to evolve into something like Org.

I hope to go beyond simply the file format and bring some of the actual Mode to Sublime. I simply cannot build the entire thing, but I hope we can build something unique and amazing in sublime, in its own right.

This Plugin

The full documentation for this plugin can be found at: Docs

Thank You

I have shamelessly built this plugin on the backs of some excellent plugins and libraries.

  • The original orgmode plugin - This work was exceptional, OrgExtended is a tribute to that work and consumes some of it.
  • sublime_ZK - The inline image preview is entirely due to the Markdown ZK plugin. ZK Thank you renerocksai for pointing out that phantoms can be used for image preview.
  • Table Edit - For now this excellent plugin is a dependency and the basis by which we offer Org style table editing. In a fiture version we may look to consume the package and own table editing to facilitate expressions and some of the more advanced org table tools, but for now, thank you for making this excellent plugin!
  • pymitter - a great little event library for python.
  • highlightjs - a wonderful highlighting library for html.
  • pandoc - a great command line tool for converting formats.

References

To help get you started on your Org journey Here are some useful external links: