docs/manual/guide/12-export.org

The keys follow Emacs's export dispatcher (org-export-dispatch). C-c C-e on its own is only a prefix: pause after it and the key hints list the formats. The SPC m e keys work in normal state; the C-c C-e keys work in every Doom state. The Mac preset has no keys for the single formats; its ⇧⌘E opens the export dialog.

All seven commands are in File ▸ Export and in the command palette. They write the export beside the Org file, with the same name and the format's extension: .html, .md, .pdf, .tex, .odt or .txt. A file already there is replaced. The message area shows "Exported to name".

Export… in the command palette, or ⇧⌘E in the Mac preset, opens a dialog. The Emacs and Doom presets have no key for it; bind app.export-dialog in keymap.toml if you want one (see Keys and commands). The dialog has:

• Format: HTML, Markdown, PDF (Emacs), ODT (Emacs), LaTeX (Emacs) or Plain text (Emacs).
• Destination: beside the Org file by default. Choose… picks another place and name. Changing the format changes the extension.
• Open after export: opens the file in its default app when the export finishes.

The dialog remembers the format and the Open after export setting.

The Export menu offers HTML and Markdown. It is under More in the editor, and in the toolbar in the reader. Choosing one opens the share sheet with the exported file, named after the Org file. Send it to another app, or use Save to Files to keep it. The export is the same as on the Mac. PDF, LaTeX, ODT and plain text are not available on iOS.

Keywords in files named by #+SETUPFILE: count, as they do in Org.

A depth for toc or num larger than H is cut to H. Any value other than nil turns an option on. Other #+OPTIONS keys are ignored.

#+TITLE: Field notes
#+AUTHOR: Sam
#+OPTIONS: toc:2 num:nil pri:t ^:{}

• A heading tagged with one of #+EXCLUDE_TAGS (noexport by default) is left out, with everything under it.
• A heading whose title starts with COMMENT is left out.
• A heading tagged ARCHIVE is exported as the heading alone, without its contents.
• If any heading has one of #+SELECT_TAGS (export by default), only those headings, their ancestors and everything under them are exported.

Each heading gets an id for links: its CUSTOM_ID property, or a slug made from its title. Headings are one level down from Org's: a top-level heading is an <h2>, since the title is the <h1>.

Each #+HTML_HEAD: and #+HTML_HEAD_EXTRA: line goes into the page's <head> as written, in order. Use them for stylesheets and scripts:

#+HTML_HEAD: <link rel="stylesheet" href="notes.css">

The built-in stylesheet is always included first. Other #+HTML_… keywords are not used.

LaTeX fragments (\(…\), \[…\], $…$, $$…$$) and LaTeX environments are left in the page for MathJax. When the page has any, Orgstar adds MathJax 3 from cdn.jsdelivr.net, so the page needs a network connection to show math. Entities such as \alpha become their characters.

#+INCLUDE: inserts another file before export, as org-export-expand-include-keyword does. Paths are relative to the Org file.

A file that cannot be read is replaced by an empty line.

{{{name(arguments)}}} is replaced before export (org-macro-replace-all).

Arguments are separated by commas; write \, for a literal comma. Macros defined with (eval …), and macros Orgstar does not know, become empty. #+MACRO: definitions in setup files count.

Footnote references, named or inline ([fn:: text]), become numbered superscript links. The notes are collected in a Footnotes section at the end, numbered in the order they are first referenced, each with a link back. A reference without a definition is exported as written.

An Org table becomes an HTML <table>. If it has rules, the rows before the first rule are the header (<thead>) and the rest the body. #+CAPTION: gives the table a caption. #+TBLFM: lines are not exported.

A table.el table (one drawn with +, - and |) becomes a table with each cell's colspan and rowspan, and the lines in a cell joined with line breaks. If its drawing is not a well-formed table, it is exported as preformatted text.

A link to an image file without a description becomes an <img>. The image types are png, jpg, jpeg, gif, svg, webp, bmp, tif, tiff and avif. #+ATTR_HTML: before the paragraph adds attributes (:width 300 :alt "Map"); without an :alt, the file name is used.

An image paragraph with #+CAPTION: or #+ATTR_HTML: becomes a <figure>; a caption is numbered "Figure 1:", "Figure 2:" and so on.

Links to .org files point to the .html file of the same name. Links to headings ([[*Heading]]), to CUSTOM_ID targets and to radio targets point to the heading's or target's id on the page. id: links point to # and the ID. Other links are written as they are.

A source block is exported as <pre><code class"language-LANG">=, with the code escaped and its common indentation removed. Orgstar does not color the code; the class lets a script or stylesheet in #+HTML_HEAD highlight it. Noweb references are shown as written. Line-number switches are ignored.

The block's :exports header argument decides what appears. Orgstar resolves it as running the block would: from the #+begin_src line, #+HEADER: lines, header-args properties and #+PROPERTY: lines (see Code blocks). Without one, it is results for dot, plantuml, ditaa, gnuplot, latex and lilypond blocks, as their Org defaults set it, and code for other languages.

A #+CALL: line exports its existing results, never the call itself; :exports code or none on the call, or in the header-args properties where the call is, exports nothing. An inline src_ block has :exports results by default: the {{{results(…)}}} after it is exported and its code is not. With :exports code the code is exported in <code> and the results are not; with both, both. An inline call_ never appears itself, and the {{{results(…)}}} after it is always exported, whatever :exports says, as in Org.

Comments, drawers, property drawers, planning lines, clock lines and keywords are not exported.

HTML and Markdown export handle citations the same way; see Citations below.

Each #+bibliography: line names one file, relative to the Org file, optionally in quotes. A file ending in .json is read as CSL-JSON; anything else is read as BibTeX, with @string abbreviations expanded and @comment and @preamble skipped. You can have several #+bibliography: lines; for a key in more than one file, the first file wins.

#+cite_export: PROCESSOR [BIBLIOGRAPHY-STYLE [CITATION-STYLE]].

• With no #+cite_export:, or with basic, citations are processed.
• With any other processor, such as csl or biblatex, Orgstar leaves citations as they are written.
• The citation style, which may include a variant (text/bare), is the default for citations that do not name one.

A citation is [cite:…] or [cite/style:…] or [cite/style/variant:…], holding one or more @key references separated by ;. Each reference may have its own prefix and suffix, and the whole citation a common prefix and suffix.

Works by the same author in the same year get a, b, … after the year. A key not found in any bibliography file shows as ?? and ????. Citations in the title are dropped.

For note citations, the blank before the citation is removed and punctuation right after it moves in front of the footnote mark, as org-cite-adjust-note does.

#+print_bibliography: is replaced by an entry for every cited work, sorted by author. The bibliography style from #+cite_export: sets the form:

The publisher part comes from the publisher, journal, institution or school field. Without #+print_bibliography: no bibliography is written.