164 lines
5.7 KiB
HTML
164 lines
5.7 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<meta
|
|
name="description"
|
|
content="kdl is a document language, mostly based on SDLang, with xml-like semantics that looks like you're invoking a bunch of CLI commands!"
|
|
/>
|
|
<title>KDL - KDL Document Language</title>
|
|
<link rel="stylesheet" href="/styles/global.css" />
|
|
</head>
|
|
<body>
|
|
<main><header class="py-10 bg-gray-300">
|
|
<h1 class="text-4xl text-center">KDL - KDL Document Language</h1>
|
|
</header>
|
|
<section class="kdl-section" id="description">
|
|
<p>KDL is a document language with xml-like semantics that looks like you're
|
|
invoking a bunch of CLI commands!</p>
|
|
<p>It's meant to be used both as a serialization format and a configuration
|
|
language, and is relatively light on syntax compared to XML.</p>
|
|
<p>There's a living <a href="https://github.com/kdl-org/kdl/blob/main/SPEC.md">specification</a>, as well as
|
|
<a href="#implementations">implementations</a>. The language is based on
|
|
<a href="https://sdlang.org">SDLang</a>, with a number of modifications and
|
|
clarifications on its syntax and behavior.</p>
|
|
</section>
|
|
<section class="kdl-section" id="design-and-discussion">
|
|
<h2>Design and Discussion</h2>
|
|
<p>KDL is still extremely new, and discussion about the format should happen over
|
|
on the <a href="https://github.com/kdl-org/kdl/discussions">discussions</a> page in the
|
|
Github repo. Feel free to jump in and give us your 2 cents!</p>
|
|
</section>
|
|
<section class="kdl-section" id="design-principles">
|
|
<h2>Design Principles</h2>
|
|
<ol>
|
|
<li>Maintainability</li>
|
|
<li>Flexibility</li>
|
|
<li>Cognitive simplicity and Learnability</li>
|
|
<li>Ease of de/serialization</li>
|
|
<li>Ease of implementation</li>
|
|
</ol>
|
|
</section>
|
|
<section class="kdl-section" id="overview">
|
|
<h2>Overview</h2>
|
|
<h3>Basics</h3>
|
|
<p>A KDL node is a node name, followed by zero or more "arguments", and
|
|
children.</p>
|
|
<pre><code class="language-kdl">title "Hello, World"
|
|
</code></pre>
|
|
<p>You can also have multiple values in a single node!</p>
|
|
<pre><code class="language-kdl">bookmarks 12 15 188 1234
|
|
</code></pre>
|
|
<p>Nodes can have properties.</p>
|
|
<pre><code class="language-kdl">author "Alex Monad" email="alex@example.com" active=true
|
|
</code></pre>
|
|
<p>And they can have nested child nodes, too!</p>
|
|
<pre><code class="language-kdl">contents {
|
|
section "First section" {
|
|
paragraph "This is the first paragraph"
|
|
paragraph "This is the second paragraph"
|
|
}
|
|
}
|
|
</code></pre>
|
|
<p>Nodes without children are terminated by a newline, a semicolon, or the end of
|
|
a file stream:</p>
|
|
<pre><code class="language-kdl">node1; node2; node3;
|
|
</code></pre>
|
|
<h3>Values</h3>
|
|
<p>KDL supports 4 data types:</p>
|
|
<ul>
|
|
<li>Strings: <code>"hello world"</code></li>
|
|
<li>Numbers: <code>123.45</code></li>
|
|
<li>Booleans: <code>true</code> and <code>false</code></li>
|
|
<li>Null: <code>null</code></li>
|
|
</ul>
|
|
<h4>Strings</h4>
|
|
<p>It supports two different formats for string input: escaped and raw.</p>
|
|
<pre><code class="language-kdl">node "this\nhas\tescapes"
|
|
other r"C:\Users\zkat\"
|
|
</code></pre>
|
|
<p>Both types of string can be multiline as-is, without a different syntax:</p>
|
|
<pre><code class="language-kdl">string "my
|
|
multiline
|
|
value"
|
|
</code></pre>
|
|
<p>And for raw strings, you can add any number of # after the r and the last " to
|
|
disambiguate literal " characters:</p>
|
|
<pre><code class="language-kdl">other-raw r#"hello"world"#
|
|
</code></pre>
|
|
<h4>Numbers</h4>
|
|
<p>There's 4 ways to represent numbers in KDL. KDL does not prescribe any
|
|
representation for these numbers, and it's entirely up to individual
|
|
implementations whether to represent all numbers with a single type, or to
|
|
have different representations for different forms.</p>
|
|
<p>KDL has regular decimal-radix numbers, with optional decimal part, as well as
|
|
an optional exponent.</p>
|
|
<pre><code class="language-kdl">num 1.234e-42
|
|
</code></pre>
|
|
<p>And using the appropriate prefix, you can also enter hexadecimal, octal, and
|
|
binary literals:</p>
|
|
<pre><code class="language-kdl">my-hex 0xdeadbeef
|
|
my-octal 0o755
|
|
my-binary 0b10101101
|
|
</code></pre>
|
|
<p>Finally, all numbers can have underscores to help readability:</p>
|
|
<pre><code class="language-kdl">bignum 1_000_000
|
|
</code></pre>
|
|
<h3>Comments</h3>
|
|
<p>KDL supports C-style comments, both line-based and multiline. Multiline
|
|
comments can be nested.</p>
|
|
<pre><code class="language-kdl">// C style
|
|
|
|
/*
|
|
C style multiline
|
|
*/
|
|
|
|
tag /*foo=true*/ bar=false
|
|
|
|
/*/*
|
|
hello
|
|
*/*/
|
|
</code></pre>
|
|
<p>On top of that, KDL supports <code>/-</code> "slashdash" comments, which can be used to
|
|
comment out individual nodes, arguments, or children:</p>
|
|
<pre><code class="language-kdl">// This entire node and its children are all commented out.
|
|
/-mynode "foo" key=1 {
|
|
a
|
|
b
|
|
c
|
|
}
|
|
|
|
mynode /-"commented" "not commented" /-key="value" /-{
|
|
a
|
|
b
|
|
}
|
|
</code></pre>
|
|
<h3>More Details</h3>
|
|
<pre><code class="language-kdl">// Nodes can be separated into multiple lines
|
|
title \
|
|
"Some title"
|
|
|
|
|
|
// Files must be utf8 encoded!
|
|
smile "😁"
|
|
|
|
// Instead of anonymous nodes, nodes and properties can be wrapped
|
|
// in "" for arbitrary node names.
|
|
"!@#$@$%Q#$%~@!40" "1.2.3" "!!!!!"=true
|
|
|
|
// The following is a legal bare identifier:
|
|
foo123~!@#$%^&*.:'|/?+ "weeee"
|
|
|
|
// And you can also use unicode!
|
|
ノード お名前＝"☜(ﾟヮﾟ☜)"
|
|
|
|
// kdl specifically allows properties and values to be
|
|
// interspersed with each other, much like CLI commands.
|
|
foo bar=true "baz" quux=false 1 2 3
|
|
</code></pre>
|
|
</section>
|
|
</main>
|
|
</body>
|
|
</html>
|