Index

Yup, this is a heading. this is bold italic link to aaa, link to test

Link to QMK

Text can be put into the headline. You can create another headline at the same level with another * character

Nesting headlines is as easy as adding another start

You can really go as deep as you want. This is the general building block for org-mode navigation.

Next, let's talk about some markup

• underscores let you underline things
• stars add emphasis
• slashes are italics
• pluses are strikethrough
• equal signs are verbatim text

• tildes can also be used

  • underscores let you underline things
  • stars add emphasis
  • slashes are italics
  • pluses are strikethrough
  • equal signs are verbatim text
  • underscores let you underline things
  • stars add emphasis
  • tildes can also be used
  • slashes are italics
  • pluses are strikethrough
  • equal signs are verbatim text

  • tildes can also be used

    • equal signs are verbatim text
    • tildes can also be used

You can generate lists with the - character (seen above), or create numbered ones:

1. Number one thing
2. Number two thing
3. Number three

You can hide the contents of a headline by putting the point (cursor) or it and hitting TAB.

You can also toggle hiding and showing of all headlines with SHIFT-TAB.

Auto expanding tables are one of the coolest features of org-mode, because tables in Markdown just plain suck. In order to create a new table, you can start typing it manually, or press C-c |, which will prompt for the table's dimensions.

:PROPERTIES:…

In an org-mode file, you can press C-c l to store a pointer to wherever you are in the file. Then, with (or without) text highlighted hit C-C C-l to make it into a link. The example file for Magit If you don't want to store a pointer (ie, link to a website or something), you can just hit C-c C-l and type or paste the link. To manually create a link, do something like:

The Denver Emacs Meetup Group

Writequit site

Google's web site

(ignore the *_SRC blocks for now, we'll get there)

[[http://google.com/][Google]]

You can link to files, images, websites, emails, irc, and all kinds of things.

One of the most common uses for org-mode is a sort of "task list" or TODO list. Org-mode supports this by allowing markers in the headline for the state of a task. Let's look at an example:

:PROPERTIES:… So TODOs are all well and good, but what is a really neat feature is when you can easily capture new TODOs and display them easily.

In order to do this, let's configure a couple of Emacs options in your emacs init:

(require 'org)
;; Setup C-c c to capture new TODOs
(global-set-key (kbd "C-c c") 'org-capture)
;; Setup a key bind for the agenda
(global-set-key (kbd "C-c a") 'org-agenda)
;; Set up agenda to know about our file, you can use a list of files or
;; directories here
(setq org-agenda-files '("~/todo.org"))
;; A new template
(setq org-capture-templates
      '(("t" "Todo" entry (file "~/todo.org")
         "* TODO %?\n%U\n")))

Now, hit C-c c to bring up the capture template list, then t to capture a new TODO item.

Once you've captured a few TODOs, you can try out the agenda by hitting C-c a, which will prompt for what agenda you'd like to see, for now hit t to see the TODO list agenda.

Org has a lot of export options, they are all contained behind a C-c C-e export backend, exporting to HTML, markdown, plain text, pdf, etc.

Maybe not in excruciating detail, but we can show off the power and cover it in more detail at a later time:

• refiling (org-refile)
• source code blocks
• org-babel
• clocking in/out
• table formulas
• custom agenda views
• capturing notes (not just TODOs)
• publishing projects remotely via TRAMP

(defun my/function ()
  "docstring"
  (interactive)
  (progn
    (+ 1 1)
    (message "Hi")))

echo $data > /tmp/foo
for i in `cat /tmp/foo`; do
    echo $i
done

echo "hi"

hi

# do some things
echo "stuff"
echo "more stuff"
echo <<hi>>

To enter and edit a block of text, use C-c C-'