Ozeki Markdown Documents

Ozeki Markdown Documents keeps Markdown as the canonical document source.

Rendered HTML is generated output that can be safely rebuilt at any time.

Each Markdown document is an independent WordPress object with its own title,

status, author, revisions, permalink, and stable numeric ID. A published

document can be displayed directly or reused from another post or page with a

shortcode.

Features include:

• A dedicated Markdown document editor.

• Side-by-side editing and safe live preview.

• Exact UTF-8.md and.markdown import and export.

• WordPress revisions for the canonical Markdown source.

• CommonMark and GitHub-Flavored Markdown rendering.

• Tables, task lists, fenced code blocks, and strikethrough.

• Locally bundled Mermaid diagram rendering.

• Locally bundled KaTeX rendering for LaTeX and beginner-friendly AsciiMath.

• An explicit Copy LaTeX control without changing mixed-selection copying.

• Interactive Markdown, Mermaid, and mathematics example libraries.

• Public document permalinks and shortcode reuse.

The rendering pipeline escapes raw HTML, rejects unsafe links, applies the

WordPress HTML allow-list, and keeps invalid diagram or formula source visible

instead of executing it. Browser libraries are bundled locally; the plugin

does not require a CDN or send document content to a third-party service.

This plugin does not replace the Gutenberg editor. It provides a separate,

portable Markdown document model that can be referenced where needed.

Source code and reproducible build instructions are maintained at:

com/ozekihiroshi/ozeki-markdown-documents

Quick Start

• Open Markdown Documents > Add New Markdown Document.

• Enter a title and write Markdown in the left pane.

• Check the safe rendered output in the right pane.

• Save a draft or publish the document.

• Use its permalink directly, or embed a published document in another post

or page with [ozeki_markdown_document id="123"].

The Markdown Guide, Mermaid Examples, and Math Examples pages provide editable

practice areas. Changes made in a guide are not saved. The explicit create

button creates a new draft and never overwrites an existing document.

Supported Markdown and Extensions

The server-side renderer supports CommonMark and GitHub-Flavored Markdown,

including headings, lists, links, tables, task lists, fenced code blocks, and

strikethrough.

Use a fenced mermaid block for diagrams:

~~~mermaid flowchart LR Source[Markdown] --> Preview[Preview] ~~~

Use a prefixed inline code span or fenced block for formulas:

• Inline AsciiMath: `asciimath:a/b`

• Inline LaTeX: `math:\frac{a}{b}`

• Display AsciiMath: an asciimath fenced block

• Display LaTeX: a math or latex fenced block

AsciiMath is converted only for derived display output. The stored Markdown is

not rewritten. Hover over or focus a rendered formula to reveal Copy LaTeX.

Copying a mixed selection of ordinary text and formulas retains normal browser

copy behavior.

Security and Privacy

Raw HTML is escaped. Unsafe link protocols are rejected, and generated HTML is

filtered through the WordPress HTML allow-list. Mermaid runs with strict

security settings and HTML labels disabled. KaTeX runs with trust disabled,

strict error handling, and size and expansion limits. Invalid diagrams and

formulas remain readable as source instead of being executed.

The plugin does not collect telemetry, track users, contact an analytics

service, or send document content to a third party. Mermaid, KaTeX, AsciiMath,

JavaScript, CSS, and fonts are bundled locally; no CDN is required. Ordinary

WordPress administrators remain responsible for deciding who may edit or view

their site content.

Stored Data and Uninstall

Documents are stored as the dedicated public ozmd_document custom post type. The

canonical Markdown source and generated render cache are stored as post meta.

WordPress revisions preserve the Markdown source. Imported original filenames

are retained only to suggest an export filename.

Deactivation and uninstall intentionally leave documents, revisions, and

associated post metadata unchanged. This prevents an accidental plugin removal

from destroying authored content. Delete documents through WordPress when

permanent removal is desired.

Third-party Libraries

The release includes League CommonMark under BSD-3-Clause and Mermaid, KaTeX,

and asciimath-parser under MIT-compatible licenses. License files and

txt are included in the plugin. Human-readable integration

source, lock files, and reproducible build tools are maintained in the public

GitHub repository linked above.

Current Scope

This release uses a dedicated Markdown document editor; Gutenberg is available

for placing shortcodes but is not the canonical Markdown editor. The plugin

does not provide cloud synchronization, collaborative editing, Git publishing,

or remote AI processing. md or

markdown files no larger than 5 MiB.