npm package: @marmotz/zolt
Description: Zolt - The high-voltage successor to Markdown
Author: Marmotz
Latest version: 0.2.0

# 📘 Zolt

_Zolt : The high-voltage successor to Markdown_

![Zolt Version](https://img.shields.io/badge/version-0.2.0-blue)
![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)
![Status](https://img.shields.io/badge/status-draft-orange)

**Zolt** is a modern markup language that combines the simplicity of Markdown with the power of professional
documentation features. Write in plain text, publish anywhere.

---

## ✨ Features

### 🎯 Core Features

- **📝 Simple Syntax** - Write in plain text, readable by anyone
- **🎨 Rich Formatting** - Bold, italic, underline, strikethrough, highlights
- **🔗 Advanced Links** - References, attributes
- **📊 Tables** - Advanced tables with merged cells
- **🖼️ Rich Media** - Images, videos, audio
- **💻 Code Blocks** - Syntax highlighting with attributes

### 🚀 Advanced Features

- **🔢 Calculations** - Built-in math with namespaces (Math, List, String, Date)
- **📋 Lists** - Bullets, numbers, tasks, definitions
- **🗂️ TOC** - Automatic table of contents
- **📑 Footnotes** - Reference-style footnotes
- **🎛️ Components** - Accordions, tabs, columns
- **📈 Charts** - Native charts (line, bar, pie, area)
- **🔄 Variables** - Reusable content variables
- **🔄 Loops** - Iterate over data structures
- **📅 Dates** - Automatic timestamps
- **🏷️ Metadata** - YAML file metadata support
- **🎨 Styling** - Universal attribute system `{}`

### 🌟 Unique to Zolt

- **Inline styling** - `||text||{attr}` for styled spans
- **Indentation** - `&` for non sementical text vs `>` for quotes
- **Numbered headings** - Automatic section numbered with multiple styles
- **Abbreviations** - Tooltip abbreviations
- **Comments** - Both block `:::comment` and inline `%% %%`

---

## 🚀 Getting Started

### Installation

Add Zolt to your project:

```bash
# npm
npm install @marmotz/zolt

# bun
bun add @marmotz/zolt

# pnpm
pnpm add @marmotz/zolt

# yarn
yarn add @marmotz/zolt
```

### Usage

Build your first `.zlt` file:

```bash
# npm
npx @marmotz/zolt build file.zlt

# bun
bunx @marmotz/zolt build file.zlt

# pnpm
pnpm dlx @marmotz/zolt build file.zlt

# yarn
yarn dlx @marmotz/zolt build file.zlt
```

For more detailed guides and full documentation, please visit our official website:

👉 **[https://zolt.marmotz.dev](https://zolt.marmotz.dev)**

---

## 🤝 Contributing

Contributions are welcome! Please:

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests
5. Submit a pull request

---

## 📜 Changelog

See the [CHANGELOG.md](CHANGELOG.md) file for a detailed list of changes for each version.

---

## 📄 License

MIT License - see LICENSE file for details

---

## 🙏 Acknowledgments

- Inspired by Markdown and modern documentation tools
- Powered by [Shiki](https://shiki.style/), [YAML](https://github.com/eemeli/yaml), [KaTeX](https://katex.org/), [Mermaid.js](https://mermaid.js.org/), and [Chart.js](https://www.chartjs.org/)
- Built for writers, developers, and content creators
- Designed with ❤️ for the community

---

## 📞 Support

- **Documentation:** [zolt.marmotz.dev](https://zolt.marmotz.dev)
- **Issues:** [GitHub Issues](https://github.com/marmotz/zolt/issues)
- **Discussions:** [GitHub Discussions](https://github.com/marmotz/zolt/discussions)

---

_Zolt : The high-voltage successor to Markdown_