Skip to content

Markup for Rich Export

SabryTarek edited this page Apr 20, 2021 · 2 revisions

Emphasis and monospace

You can make words bold, italic, underlined, verbatim and code. Text in the code and verbatim string is not processed for Org mode specific syntax, it is exported verbatim.

  • bold: *
  • italic: /
  • underlined: _
  • verbatim: =
  • code: ~

You can also mark lines as literals (quotations) by preceding them with :.

1. Refusal of the *Return*
2. The Magic /Flight/
3. Rescue from _Without_
4. ~The Crossing of the Return Threshold~
5. Master of Two =Worlds=
6. Freedom to Live
: with a literal

VS Code Org Mode provides the following actions for adding markup inspired by the Spacemacs Org layer.

Org: Bold

Bold selected text.

  • Command: org.bold
  • Key: ctrl+alt+o b

Org: Italic

Italicize selected text.

  • Command: org.italic
  • Key: ctrl+alt+o i

Org: Underline

Underline selected text.

  • Command: org.underline
  • Key: ctrl+alt+o u

Org: Code

Format selected text as code.

  • Command: org.code
  • Key: ctrl+alt+o c

Org: Verbose

Format selected text as verbatim. The name verbose was chosen in keeping with the Spacemacs original.

  • Command: org.verbose
  • Key: ctrl+alt+o v

Org: Literal

Format the current line as a literal (quotation).

  • Command: org.literal
  • Key: ctrl+alt+o l

Structural markup elements

Document title

Set a document’s title with the line #+TITLE:

#+TITLE: Magna Carta

Also available from the following snippet:

  • Prefix: title
  • Body: #+TITLE: ${1:title text}

Document options

  • Prefix: options
  • Body: #+OPTIONS: ${1:option text}

Document table of contents

  • Prefix: toc
  • Body: #+TOC: ${1:toc text}

Include file for export

  • Prefix: include
  • Body: #+INCLUDE: ${1:include file}