Org mode for Emacs

Org Mode
Your life in plain text

A GNU Emacs major mode for convenient plain text markup — and much more.

Org mode is for keeping notes, maintaining to-do lists, planning projects, authoring documents, computational notebooks, literate programming and more — in a fast and effective plain text system.

Support via Liberapay GitHub PayPal

Highlights

Features

Install

Quickstart

Contribute

Org is a highly flexible structured plain text file format, composed of a few simple, yet versatile, structures — constructed to be both simple enough for the novice and powerful enough for the expert.

Get a glimpse of the expressive power Org offers in the example below. Click the headlines and links to discover how Org intelligently folds structural content.

Metadata

#+title:  Example Org File
#+author: TEC
#+date:   2020-10-27

Outlining

Headlines and folding make structured editing a breeze. Plain text makes it easy to sync and version control Org files.

* Revamp orgmode.org website

Agenda

List todos across all your files. Filter content, and update it in place.


The /beauty/ of org *must* be shared.

[[https://upload.wikimedia.org/wikipedia/commons/b/bd/Share_Icon.svg]]

** DONE Make screenshots

   CLOSED: [2020-09-03 Thu 18:24]

** DONE Restyle Site CSS


Go through [[file:style.scss][stylesheet]]

** TODO Check CSS on main pages


- Index page
- Quickstart
- Features
- Releases
- Install
- Manual
- Contribute

Prose

* Learn Org


Org makes easy things trivial and complex things practical.

You don't need to learn Org before using Org: read the quickstart
page and you should be good to go.  If you need more, Org will be
here for you as well: dive into the manual and join the community!

** Feedback


#+include: "other/feedback.org*manual" :only-contents t

* Check CSS minification ratios

Babel

Perform literate programming in org, with notebook-like live code execution in the buffer. Code

#+begin_src python

from pathlib import Path
cssRatios = []
for css_min in Path("resources/style").glob("*.min.css"):
    css = css_min.with_suffix('').with_suffix('.css')
    cssRatios.append([css.name,
    "{:.0f}% minified ({:4.1f} KiB)".format( 100 *
                      css_min.stat().st_size / css.stat().st_size,
                      css_min.stat().st_size / 1000)])
return cssRatios

#+end_src

Evaluated results

#+RESULTS:

| index.css    | 76% minified ( 1.4 KiB) |
| org-demo.css | 77% minified ( 2.8 KiB) |
| errors.css   | 74% minified ( 4.9 KiB) |
| org.css      | 75% minified (10.7 KiB) |

More Org

The de facto mimetype for Org files is text/org. Org files use the .org extension. Most operating systems don't know to open .org files in Emacs, but they can be configured to do so without much effort.

While the reference implementation of Org in Emacs lisp is by far the most featureful, there are many additional tools that work with Org.

Tools that work with Org

Worg, a World of Org

Org and Org-mode have so many use cases that it is simply not possible to easily document them, let alone show them all off on a single page. As a result, Worg serves as a community wiki and provides a place to document and share information about all aspects of using and working with Org.

For example, Worg contains:

The FAQ
Org hacks
A list of tutorials
Documentation on all hooks, commands and options
Org in the wild
…and much more

Worg is maintained as a Git repository of Org files that are published as an HTML website. New contributors are welcome.

~$ git clone https://code.orgmode.org/bzg/worg.git

Org Mode Your life in plain text