Skip to content

Commit e9785a4

Browse files
committed
First commit
0 parents  commit e9785a4

File tree

7 files changed

+2427
-0
lines changed

7 files changed

+2427
-0
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
/.vitepress/cache/
2+
/node_modules/
3+
.idea/

.vitepress/config.mts

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
import { defineConfig } from 'vitepress'
2+
3+
// https://vitepress.dev/reference/site-config
4+
export default defineConfig({
5+
title: "MAML",
6+
description: "Minimal Abstract Markup Language",
7+
themeConfig: {
8+
// https://vitepress.dev/reference/default-theme-config
9+
nav: [
10+
{ text: 'Home', link: '/' },
11+
],
12+
13+
sidebar: [
14+
{
15+
text: 'Examples',
16+
items: [
17+
{ text: 'Markdown Examples', link: '/markdown-examples' },
18+
{ text: 'Runtime API Examples', link: '/api-examples' }
19+
]
20+
}
21+
],
22+
23+
socialLinks: [
24+
{ icon: 'github', link: 'https://github.com/maml-dev/maml' }
25+
]
26+
}
27+
})

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Anton Medvedev
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# MAML — Minimal Abstract Markup Language
2+
3+
**MAML** is a minimal and efficient markup language designed to be straightforward to parse and easy to write.
4+
5+
---
6+
7+
## ✨ Why MAML?
8+
9+
* **Minimal** → No unnecessary symbols, noise, or quirks.
10+
* **Readable** → Intuitive syntax that feels natural for humans.
11+
* **Familiar** → Inspired by JSON, but with a modern twist.
12+
* **Efficient** → Lightweight and fast, from small configs to massive APIs.
13+
* **Extensible** → Scales across projects, tools, and environments.
14+
15+
---
16+
17+
## 🔍 Example
18+
19+
20+
```maml
21+
{
22+
project: "MAML"
23+
tags: [
24+
"minimal"
25+
"readable"
26+
]
27+
28+
# A simple nested object
29+
spec: {
30+
version: 1
31+
author: "Anton Medvedev"
32+
}
33+
34+
# Array of objects with nested objects
35+
examples: [
36+
{
37+
json: {
38+
name: "JSON"
39+
born: 2001
40+
}
41+
}
42+
]
43+
44+
notes: """
45+
This is a multiline strings.
46+
Keeps formatting as-is.
47+
"""
48+
}
49+
```
50+
51+
---
52+
53+
## ⚖️ MAML vs Others
54+
55+
| Feature | JSON | YAML | TOML | **MAML** |
56+
|-------------------|-----------|-----------|-----------|--------------|
57+
| Human readability | ⚠️ Medium | ✅ High | ✅ High | ✅✅ Very High |
58+
| Verbosity | ❌ High | ⚠️ Medium | ✅ Low | ✅ Very Low |
59+
| Parsing speed | ✅ Fast | ⚠️ Medium | ✅ Fast | ✅ Fast |
60+
| Learning curve | ✅ Easy | ❌ Tricky | ⚠️ Medium | ✅ Easy |
61+
62+
---
63+
64+
## 🌍 Philosophy
65+
66+
MAML follows one simple rule:
67+
**Data should be effortless to write, read, and share.**
68+
69+
Whether you’re configuring apps, defining APIs, or structuring data at scale, MAML is here to make your workflow faster,
70+
cleaner, and smarter.

index.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
layout: home
3+
4+
hero:
5+
name: "MAML"
6+
text: "Minimal Abstract Markup Language"
7+
---
8+
9+
10+
```maml
11+
{
12+
project: "MAML"
13+
tags: [
14+
"minimal"
15+
"readable"
16+
]
17+
18+
# A simple nested object
19+
spec: {
20+
version: 1
21+
author: "Anton Medvedev"
22+
}
23+
24+
# Array of objects with nested objects
25+
examples: [
26+
{
27+
json: {
28+
name: "JSON"
29+
born: 2001
30+
}
31+
}
32+
]
33+
34+
notes: """
35+
This is a multiline strings.
36+
Keeps formatting as-is.
37+
"""
38+
}
39+
```
40+

0 commit comments

Comments
 (0)