this is very AI generated bare scaffolding. make sure this is not guaranteed to work normally.

🦝 Tanu Markdown (TMD)

Tanu Markdown (TMD) is a self-contained Markdown format that lets you embed images, databases, and binary data directly into Markdown.

Each .tmd file combines Markdown text + embedded assets + metadata (manifest) into a single portable document.

---

📦 Repository Structure

Directory	Description
tmd-sample/	.tmd / .tmdz samples and format reference
tmd-vscode/	VSCode extension placeholder "Tanu Markdown Editor" (TypeScript)
tmd-core/	Rust library core (data structures, manifest handling)
tmd-cli/	Rust CLI tool for TMD document operations

---

🛠 Development Environment

Run everything in Docker

The repository ships with a ready-to-use development image. Build it once and start an interactive shell:

docker compose build
docker compose run --rm dev bash

Rust, Cargo, Node.js and the TypeScript toolchain are available in the container. Workspace volumes are mounted so edits on the host are reflected instantly.

VS Code Dev Container

When using VS Code, install the Dev Containers extension and choose “Open Folder in Container…”. The .devcontainer configuration provisions the same image, installs rustfmt/clippy, and runs npm install for the VSCode extension automatically.

Install the VS Code extension (developer build)

You can side-load the placeholder extension package into VS Code to verify activation before editor features ship:

1. cd tmd-vscode
2. npm install
3. npm run compile
4. npm exec vsce package
5. code --install-extension tanu-markdown-editor-0.0.1.vsix

The packaged extension only exposes a welcome command (Tanu Markdown Editor: Show Welcome) that confirms successful installation.

---

🧩 File Format Overview

.tmd — Polyglot Format (Markdown + ZIP)

+------------------------+
| Markdown (UTF-8 text)  |
+------------------------+
| ZIP archive (manifest, |
| images/, data/, etc.)  |
+------------------------+
| EOCD comment           |
|  TMD1\0<md_len_le64>   |
+------------------------+

.tmdz — ZIP format

• Same as .tmd but stored as a regular ZIP file
• Contains index.md, manifest.json, images/, and data/

---

🧰 Components

tmd-vscode/

Tanu Markdown Editor, a VS Code extension placeholder written in TypeScript. The current build only registers a welcome command so that the package can be installed and tested before real editing features arrive.

tmd-core/

Rust library defining the TMD document model:

• TmdDoc structure for Markdown, manifest, and attachments
• to_bytes() / open_bytes() (stubs for polyglot serialization)

tmd-cli/

Rust CLI utility for working with .tmd files.

cargo run -- new mydoc.tmd --title "My Document"
cargo run -- validate mydoc.tmd
cargo run -- export-html mydoc.tmd out.html --self-contained

---

🧱 Roadmap

• Implement .tmd read/write logic (EOCD parsing, ZIP build)
• Attachment management UI in VSCode extension
• .tmd → HTML / PDF export
• SQLite embedding and SQL evaluation
• Draft formal file specification

---

📜 License

MIT License
(c) 2025 Tanu Markdown Project

---

🧡 Tanu Markdown — Markdown that packs everything inside.