# Markdown Office

> One Markdown document becomes a Word document or a PowerPoint deck. In PHP, with no Office and
> no binaries. Both halves read the same directive syntax. One part converts a document back to
> Markdown as well.

This documentation is built from Markdown, and every example in it was produced by the library
it documents at the moment the site was built. The same pages are available as Markdown one page
at a time, and there is a JSON index at https://markdown-office.github.io/pages.json.


## Markdown Word

- [Markdown Word](https://markdown-office.github.io/word/): CommonMark and GitHub Flavored Markdown into .docx, .odt and .rtf — extended with frontmatter and themes, and with two directives — and back out again.
- [Word directives](https://markdown-office.github.io/word/directives/): ::toc and :footnote are drawn. Everything else is written into the document exactly as the author typed it.
- [Configuration](https://markdown-office.github.io/word/configuration/): Every frontmatter key, every option, every style slot and its default — and the parser you have to pass to read any of it.
- [Round trips](https://markdown-office.github.io/word/round-trip/): Markdown to a document and back. What comes out the same, and the five things that do not.
- [Image options](https://markdown-office.github.io/word/images/): The three options that decide what happens to a picture, and the two calls that report what happened to it.
- [Errors](https://markdown-office.github.io/word/errors/): Every exception Markdown Word throws, and what each one means.

## Markdown Presentation

- [Markdown Presentation](https://markdown-office.github.io/presentation/): Slidev-inspired Markdown into .pptx — layouts, themes, click builds and speaker notes, extended with directives. One direction only.
- [Presentation directives](https://markdown-office.github.io/presentation/directives/): ::click, :::click, ::column and ::note — plus the closed set of frontmatter keys, and everything the deck will refuse by name.
- [Themes and layout](https://markdown-office.github.io/presentation/themes/): The twelve colour slots, the thirteen style keys, the eight layout roles, and the four themes that ship with the presentation package.
- [Errors](https://markdown-office.github.io/presentation/errors/): Every exception Markdown Presentation throws, and what each one means.

## In general

- [How directives work](https://markdown-office.github.io/directives/): One syntax, three shapes, and what each half of the suite does with a name it recognises — and with one it does not.
- [The directive syntax](https://markdown-office.github.io/directives/syntax/): Every rule of :name, ::name and :::name — names, labels, attributes, fences, and the four things that look like directives and are not.
- [Images](https://markdown-office.github.io/images/): What is carried, what is converted, what is refused, and the pixel ceiling that makes a 152-byte file expensive.
- [Errors in general](https://markdown-office.github.io/errors/): The exception to catch for each package, the two classes that share a name, and what the messages say about paths and losses.

## The command line

- [Installation](https://markdown-office.github.io/command-line/installation/): The executables, the archive, Composer, Homebrew and winget — five ways to get the tool, and what each one needs.
- [Basic use](https://markdown-office.github.io/command-line/basic/): The parts, every command, the exit codes, the pipes, and how it decides which way the data has to go.
- [For presentations](https://markdown-office.github.io/command-line/presentations/): The options `mdoffice slides to-pptx` takes, and the dialect the deck is read with.
- [For word](https://markdown-office.github.io/command-line/word/): The options `mdoffice word` takes, for the three formats it writes and for the one it reads.

## The suite

- [The suite](https://markdown-office.github.io/suite/): Three packages with no facade between them, one command line over the two

## Optional

- [Every page in one file](llms-full.txt): the whole set as one Markdown document.
- [The index as JSON](pages.json): section, title, summary and URL for each page.