📘 Zolt

Zolt : The high-voltage successor to Markdown

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 numbering with multiple styles
• Abbreviations - Tooltip abbreviations
• Comments - Both block :::comment and inline %% %%

🚀 Getting Started

Installation

Add Zolt to your project:

# 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:

# 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

🤝 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

📄 License

MIT License - see LICENSE file for details

🙏 Acknowledgments

• Inspired by Markdown and modern documentation tools
• Powered by Shiki, YAML, and KaTeX
• Built for writers, developers, and content creators
• Designed with ❤️ for the community

📞 Support

• Documentation: zolt.marmotz.dev
• Issues: GitHub Issues
• Discussions: GitHub Discussions

Zolt : The high-voltage successor to Markdown